2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
65 .It Cm init Ar repository-path
66 Create a new empty repository at the specified
73 command must be used to populate the empty repository before
79 .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
80 Create an initial commit in a repository from the file hierarchy
83 The created commit will not have any parent commits, i.e. it will be a
85 Also create a new reference which provides a branch name for the newly
87 Show the path of each imported file to indicate progress.
93 environment variable to be set,
98 configuration settings can be obtained from the repository's
100 file or from Git's global
111 instead of creating the default branch
113 Use of this option is required if the
115 branch already exists.
117 Use the specified log message when creating the new commit.
122 opens a temporary file in an editor where a log message can be written.
123 .It Fl r Ar repository-path
124 Use the repository at the specified path.
125 If not specified, assume the repository is located at or above the current
128 Ignore files or directories with a name which matches the specified
130 This option may be specified multiple times to build a list of ignore patterns.
133 follows the globbing rules documented in
139 .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
140 Copy files from a repository into a new work tree.
141 Show the status of each affected file, using the following status codes:
142 .Bl -column YXZ description
143 .It A Ta new file was added
144 .It E Ta file already exists in work tree's meta-data
149 is not specified, either use the last component of
150 .Ar repository path ,
153 was specified use the last component of
161 Proceed with the checkout operation even if the directory at
164 Existing files will be left intact.
166 Check out files from a commit on the specified
168 If this option is not specified, a branch resolved via the repository's HEAD
169 reference will be used.
171 Check out files from the specified
173 on the selected branch.
174 The expected argument is a commit ID SHA1 hash or an existing reference
175 or tag name which will be resolved to a commit ID.
176 An abbreviated hash argument will be expanded to a full SHA1 hash
177 automatically, provided the abbreviation is unique.
178 If this option is not specified, the most recent commit on the selected
180 .It Fl p Ar path-prefix
181 Restrict the work tree to a subset of the repository's tree hierarchy.
182 Only files beneath the specified
189 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
190 Update an existing work tree to a different commit.
191 Show the status of each affected file, using the following status codes:
192 .Bl -column YXZ description
193 .It U Ta file was updated and contained no local changes
194 .It G Ta file was updated and local changes were merged cleanly
195 .It C Ta file was updated and conflicts occurred during merge
196 .It D Ta file was deleted
197 .It A Ta new file was added
198 .It \(a~ Ta versioned file is obstructed by a non-regular file
199 .It ! Ta a missing versioned file was restored
204 is specified, update the entire work tree.
205 Otherwise, restrict the update operation to files at or within the
207 Each path is required to exist in the update operation's target commit.
208 Files in the work tree outside specified paths will remain unchanged and
209 will retain their previously recorded base commit.
212 commands may refuse to run while the work tree contains files from
213 multiple base commits.
214 The base commit of such a work tree can be made consistent by running
216 across the entire work tree.
219 is incompatible with the
224 cannot update paths with staged changes.
225 If changes have been staged with
227 these changes must first be committed with
237 Switch the work tree's branch reference to the specified
239 before updating the work tree.
240 This option requires that all paths in the work tree are updated.
242 Update the work tree to the specified
244 The expected argument is a commit ID SHA1 hash or an existing reference
245 or tag name which will be resolved to a commit ID.
246 An abbreviated hash argument will be expanded to a full SHA1 hash
247 automatically, provided the abbreviation is unique.
248 If this option is not specified, the most recent commit on the work tree's
254 .It Cm status Op Ar path ...
255 Show the current modification status of files in a work tree,
256 using the following status codes:
257 .Bl -column YXZ description
258 .It M Ta modified file
259 .It A Ta file scheduled for addition in next commit
260 .It D Ta file scheduled for deletion in next commit
261 .It C Ta modified or added file which contains merge conflicts
262 .It ! Ta versioned file was expected on disk but is missing
263 .It \(a~ Ta versioned file is obstructed by a non-regular file
264 .It ? Ta unversioned item not tracked by
266 .It m Ta modified file modes (executable bit only)
267 .It N Ta non-existent
269 specified on the command line
274 is specified, show modifications in the entire work tree.
275 Otherwise, show modifications at or within the specified paths.
277 If changes have been staged with
279 staged changes are shown in the second output column, using the following
281 .Bl -column YXZ description
282 .It M Ta file modification is staged
283 .It A Ta file addition is staged
284 .It D Ta file deletion is staged
287 Changes created on top of staged changes are indicated in the first column:
288 .Bl -column YXZ description
289 .It MM Ta file was modified after earlier changes have been staged
290 .It MA Ta file was modified after having been staged for addition
293 For compatibility with
304 files in each traversed directory and will not display unversioned files
305 which match these patterns.
310 supports consecutive asterisks,
312 which will match an arbitrary amount of directories.
316 only supports a single ignore pattern per line.
320 does not support negated ignore patterns prefixed with
322 and gives no special significance to the location of path component separators,
328 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Op Ar path
329 Display history of a repository.
332 is specified, show only commits which modified this path.
339 Display individual commits which were merged into the current branch
343 shows the linear history of the current branch only.
345 Start traversing history at the specified
347 The expected argument is a commit ID SHA1 hash or an existing reference
348 or tag name which will be resolved to a commit ID.
349 An abbreviated hash argument will be expanded to a full SHA1 hash
350 automatically, provided the abbreviation is unique.
351 If this option is not specified, default to the work tree's current branch
352 if invoked in a work tree, or to the repository's HEAD reference.
354 Set the number of context lines shown in diffs with
356 By default, 3 lines of context are shown.
358 Limit history traversal to a given number of commits.
359 If this option is not specified, a default limit value of zero is used,
360 which is treated as an unbounded limit.
362 .Ev GOT_LOG_DEFAULT_LIMIT
363 environment variable may be set to change this default value.
365 Display the patch of modifications made in each commit.
368 is specified, only show the patch of modifications at or within this path.
369 .It Fl s Ar search-pattern
370 If specified, show only commits with a log message matched by the extended
373 Regular expression syntax is documented in
375 .It Fl r Ar repository-path
376 Use the repository at the specified path.
377 If not specified, assume the repository is located at or above the current
379 If this directory is a
381 work tree, use the repository path associated with this work tree.
383 .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
384 When invoked within a work tree with less than two arguments, display
385 uncommitted changes in the work tree.
388 is specified, only show changes within this path.
390 If two arguments are provided, treat each argument as a reference, a tag
391 name, or an object ID SHA1 hash, and display differences between the
392 corresponding objects.
393 Both objects must be of the same type (blobs, trees, or commits).
394 An abbreviated hash argument will be expanded to a full SHA1 hash
395 automatically, provided the abbreviation is unique.
402 Set the number of context lines shown in the diff.
403 By default, 3 lines of context are shown.
404 .It Fl r Ar repository-path
405 Use the repository at the specified path.
406 If not specified, assume the repository is located at or above the current
408 If this directory is a
410 work tree, use the repository path associated with this work tree.
412 Show changes staged with
414 instead of showing local changes.
415 This option is only valid when
417 is invoked in a work tree.
419 Ignore whitespace-only changes.
424 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
425 Display line-by-line history of a file at the specified path.
432 Start traversing history at the specified
434 The expected argument is a commit ID SHA1 hash or an existing reference
435 or tag name which will be resolved to a commit ID.
436 An abbreviated hash argument will be expanded to a full SHA1 hash
437 automatically, provided the abbreviation is unique.
438 .It Fl r Ar repository-path
439 Use the repository at the specified path.
440 If not specified, assume the repository is located at or above the current
442 If this directory is a
444 work tree, use the repository path associated with this work tree.
449 .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
450 Display a listing of files and directories at the specified
451 directory path in the repository.
452 Entries shown in this listing may carry one of the following trailing
454 .Bl -column YXZ description
455 .It @ Ta entry is a symbolic link
456 .It / Ta entry is a directory
457 .It * Ta entry is an executable file
458 .It $ Ta entry is a Git submodule
463 is specified, list the repository path corresponding to the current
464 directory of the work tree, or the root directory of the repository
465 if there is no work tree.
472 List files and directories as they appear in the specified
474 The expected argument is a commit ID SHA1 hash or an existing reference
475 or tag name which will be resolved to a commit ID.
476 An abbreviated hash argument will be expanded to a full SHA1 hash
477 automatically, provided the abbreviation is unique.
478 .It Fl r Ar repository-path
479 Use the repository at the specified path.
480 If not specified, assume the repository is located at or above the current
482 If this directory is a
484 work tree, use the repository path associated with this work tree.
486 Show object IDs of files (blob objects) and directories (tree objects).
488 Recurse into sub-directories in the repository.
493 .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
494 Manage references in a repository.
496 If no options are passed, expect two arguments and attempt to create,
497 or update, the reference with the given
499 and make it point at the given
501 The name must be an absolute reference name, i.e. it must begin with
503 The target may be an object ID SHA1 hash or an existing reference which
504 will be resolved to an object ID.
505 An abbreviated hash argument will be expanded to a full SHA1 hash
506 automatically, provided the abbreviation is unique.
512 .It Fl r Ar repository-path
513 Use the repository at the specified path.
514 If not specified, assume the repository is located at or above the current
516 If this directory is a
518 work tree, use the repository path associated with this work tree.
520 List all existing references in the repository.
522 Delete the reference with the specified name from the repository.
524 Create a symbolic reference pointing at the specified
526 which must be an existing reference.
527 Care should be taken not to create loops between references when
530 .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
531 Manage branches in a repository.
533 Branches are managed via references which live in the
538 command operates on references in this namespace only.
540 If invoked in a work tree without any arguments, print the name of the
541 work tree's current branch.
544 argument is passed, attempt to create a branch reference with the given name.
545 By default the new branch reference will point at the latest commit on the
546 work tree's current branch if invoked in a work tree, and otherwise to a commit
547 resolved via the repository's HEAD reference.
554 Make a newly created branch reference point at the specified
558 argument is a commit ID SHA1 hash or an existing reference
559 or tag name which will be resolved to a commit ID.
560 .It Fl r Ar repository-path
561 Use the repository at the specified path.
562 If not specified, assume the repository is located at or above the current
564 If this directory is a
566 work tree, use the repository path associated with this work tree.
568 List all existing branches in the repository.
569 If invoked in a work tree, the work tree's current branch is shown
570 with one the following annotations:
571 .Bl -column YXZ description
572 .It * Ta work tree's base commit matches the branch tip
573 .It \(a~ Ta work tree's base commit is out-of-date
576 Delete the branch with the specified name from the repository.
577 Only the branch reference is deleted.
578 Any commit, tree, and blob objects belonging to the branch
579 remain in the repository and may be removed separately with
580 Git's garbage collector.
585 .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
586 Manage tags in a repository.
588 Tags are managed via references which live in the
593 command operates on references in this namespace only.
594 References in this namespace point at tag objects which contain a pointer
595 to another object, a tag message, as well as author and timestamp information.
597 Expect one or two arguments and attempt to create a tag with the given
599 and make this tag point at the given
601 If no commit is specified, default to the latest commit on the work tree's
602 current branch if invoked in a work tree, and to a commit resolved via
603 the repository's HEAD reference otherwise.
604 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
605 reference or tag name which will be resolved to a commit ID.
606 An abbreviated hash argument will be expanded to a full SHA1 hash
607 automatically, provided the abbreviation is unique.
614 Use the specified tag message when creating the new tag
619 opens a temporary file in an editor where a tag message can be written.
620 .It Fl r Ar repository-path
621 Use the repository at the specified path.
622 If not specified, assume the repository is located at or above the current
624 If this directory is a
626 work tree, use the repository path associated with this work tree.
628 List all existing tags in the repository instead of creating a new tag.
629 If this option is used, no other command-line arguments are allowed.
634 command will not delete tags or change existing tags.
635 If a tag must be deleted, the
637 command may be used to delete a tag's reference.
638 This should only be done if the tag has not already been copied to
640 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
641 Schedule unversioned files in a work tree for addition to the
642 repository in the next commit.
649 Permit recursion into directories.
650 If this option is not specified,
652 will refuse to run if a specified
656 With -R, add files even if they match a
660 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
661 Remove versioned files from a work tree and schedule them for deletion
662 from the repository in the next commit.
669 Perform the operation even if a file contains uncommitted modifications.
671 Keep affected files on disk.
673 Permit recursion into directories.
674 If this option is not specified,
676 will refuse to run if a specified
683 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
684 Revert any uncommitted changes in files at the specified paths.
685 File contents will be overwritten with those contained in the
686 work tree's base commit.
687 There is no way to bring discarded changes back after
690 If a file was added with
692 it will become an unversioned file again.
693 If a file was deleted with
702 Instead of reverting all changes in files, interactively select or reject
703 changes to revert based on
709 (quit reverting this file) responses.
710 If a file is in modified status, individual patches derived from the
711 modified file content can be reverted.
712 Files in added or deleted status may only be reverted in their entirety.
713 .It Fl F Ar response-script
721 responses line-by-line from the specified
723 file instead of prompting interactively.
725 Permit recursion into directories.
726 If this option is not specified,
728 will refuse to run if a specified
735 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
736 Create a new commit in the repository from changes in a work tree
737 and use this commit as the new base commit for the work tree.
740 is specified, commit all changes in the work tree.
741 Otherwise, commit changes at or within the specified paths.
743 If changes have been explicitly staged for commit with
745 only commit staged changes and reject any specified paths which
746 have not been staged.
748 Show the status of each affected file, using the following status codes:
749 .Bl -column YXZ description
750 .It M Ta modified file
751 .It D Ta file was deleted
752 .It A Ta new file was added
753 .It m Ta modified file modes (executable bit only)
756 Files which are not part of the new commit will retain their previously
757 recorded base commit.
760 commands may refuse to run while the work tree contains files from
761 multiple base commits.
762 The base commit of such a work tree can be made consistent by running
764 across the entire work tree.
770 environment variable to be set,
775 configuration settings can be
776 obtained from the repository's
778 file or from Git's global
787 Use the specified log message when creating the new commit.
792 opens a temporary file in an editor where a log message can be written.
796 will refuse to run if certain preconditions are not met.
797 If the work tree's current branch is not in the
799 reference namespace, new commits may not be created on this branch.
800 Local changes may only be committed if they are based on file content
801 found in the most recent commit on the work tree's branch.
802 If a path is found to be out of date,
804 must be used first in order to merge local changes with changes made
809 .It Cm cherrypick Ar commit
810 Merge changes from a single
815 must be on a different branch than the work tree's base commit.
816 The expected argument is a reference or a commit ID SHA1 hash.
817 An abbreviated hash argument will be expanded to a full SHA1 hash
818 automatically, provided the abbreviation is unique.
820 Show the status of each affected file, using the following status codes:
821 .Bl -column YXZ description
822 .It G Ta file was merged
823 .It C Ta file was merged and conflicts occurred during merge
824 .It ! Ta changes destined for a missing file were not merged
825 .It D Ta file was deleted
826 .It d Ta file's deletion was obstructed by local modifications
827 .It A Ta new file was added
828 .It \(a~ Ta changes destined for a non-regular file were not merged
831 The merged changes will appear as local changes in the work tree, which
834 amended manually or with further
839 or discarded again with
843 will refuse to run if certain preconditions are not met.
844 If the work tree contains multiple base commits it must first be updated
845 to a single base commit with
847 If the work tree already contains files with merge conflicts, these
848 conflicts must be resolved first.
852 .It Cm backout Ar commit
853 Reverse-merge changes from a single
858 must be on the same branch as the work tree's base commit.
859 The expected argument is a reference or a commit ID SHA1 hash.
860 An abbreviated hash argument will be expanded to a full SHA1 hash
861 automatically, provided the abbreviation is unique.
863 Show the status of each affected file, using the following status codes:
864 .Bl -column YXZ description
865 .It G Ta file was merged
866 .It C Ta file was merged and conflicts occurred during merge
867 .It ! Ta changes destined for a missing file were not merged
868 .It D Ta file was deleted
869 .It d Ta file's deletion was obstructed by local modifications
870 .It A Ta new file was added
871 .It \(a~ Ta changes destined for a non-regular file were not merged
874 The reverse-merged changes will appear as local changes in the work tree,
875 which may be viewed with
877 amended manually or with further
882 or discarded again with
886 will refuse to run if certain preconditions are not met.
887 If the work tree contains multiple base commits it must first be updated
888 to a single base commit with
890 If the work tree already contains files with merge conflicts, these
891 conflicts must be resolved first.
895 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
896 Rebase commits on the specified
898 onto the tip of the current branch of the work tree.
901 must share common ancestry with the work tree's current branch.
902 Rebasing begins with the first descendant commit of the youngest
903 common ancestor commit shared by the specified
905 and the work tree's current branch, and stops once the tip commit
910 Rebased commits are accumulated on a temporary branch which the work tree
911 will remain switched to throughout the entire rebase operation.
912 Commits on this branch represent the same changes with the same log
913 messages as their counterparts on the original
915 but with different commit IDs.
916 Once rebasing has completed successfully, the temporary branch becomes
917 the new version of the specified
919 and the work tree is automatically switched to it.
921 While rebasing commits, show the status of each affected file,
922 using the following status codes:
923 .Bl -column YXZ description
924 .It G Ta file was merged
925 .It C Ta file was merged and conflicts occurred during merge
926 .It ! Ta changes destined for a missing file were not merged
927 .It D Ta file was deleted
928 .It d Ta file's deletion was obstructed by local modifications
929 .It A Ta new file was added
930 .It \(a~ Ta changes destined for a non-regular file were not merged
933 If merge conflicts occur the rebase operation is interrupted and may
934 be continued once conflicts have been resolved.
935 Alternatively, the rebase operation may be aborted which will leave
937 unmodified and the work tree switched back to its original branch.
939 If a merge conflict is resolved in a way which renders the merged
940 change into a no-op change, the corresponding commit will be elided
941 when the rebase operation continues.
944 will refuse to run if certain preconditions are not met.
945 If the work tree is not yet fully updated to the tip commit of its
946 branch then the work tree must first be updated with
948 If changes have been staged with
950 these changes must first be committed with
954 If the work tree contains local changes, these changes must first be
961 contains changes to files outside of the work tree's path prefix,
962 the work tree cannot be used to rebase this branch.
968 commands will refuse to run while a rebase operation is in progress.
969 Other commands which manipulate the work tree may be used for
970 conflict resolution purposes.
977 Abort an interrupted rebase operation.
978 If this option is used, no other command-line arguments are allowed.
980 Continue an interrupted rebase operation.
981 If this option is used, no other command-line arguments are allowed.
986 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
987 Edit commit history between the work tree's current base commit and
988 the tip commit of the work tree's current branch.
990 Editing of commit history is controlled via a
992 which can be edited interactively or passed on the command line.
993 The format of the histedit script is line-based.
994 Each line in the script begins with a command name, followed by
995 whitespace and an argument.
996 For most commands, the expected argument is a commit ID SHA1 hash.
997 Any remaining text on the line is ignored.
998 Lines which begin with the
1000 character are ignored entirely.
1002 The available commands are as follows:
1003 .Bl -column YXZ pick-commit
1004 .It pick Ar commit Ta Use the specified commit as it is.
1005 .It edit Ar commit Ta Use the specified commit but once changes have been
1006 merged into the work tree interrupt the histedit operation for amending.
1007 .It fold Ar commit Ta Combine the specified commit with the next commit
1008 listed further below that will be used.
1009 .It drop Ar commit Ta Remove this commit from the edited history.
1010 .It mesg Ar log-message Ta Use the specified single-line log message for
1011 the commit on the previous line.
1012 If the log message argument is left empty, open an editor where a new
1013 log message can be written.
1016 Every commit in the history being edited must be mentioned in the script.
1017 Lines may be re-ordered to change the order of commits in the edited history.
1019 Edited commits are accumulated on a temporary branch which the work tree
1020 will remain switched to throughout the entire histedit operation.
1021 Once history editing has completed successfully, the temporary branch becomes
1022 the new version of the work tree's branch and the work tree is automatically
1025 While merging commits, show the status of each affected file,
1026 using the following status codes:
1027 .Bl -column YXZ description
1028 .It G Ta file was merged
1029 .It C Ta file was merged and conflicts occurred during merge
1030 .It ! Ta changes destined for a missing file were not merged
1031 .It D Ta file was deleted
1032 .It d Ta file's deletion was obstructed by local modifications
1033 .It A Ta new file was added
1034 .It \(a~ Ta changes destined for a non-regular file were not merged
1037 If merge conflicts occur the histedit operation is interrupted and may
1038 be continued once conflicts have been resolved.
1039 Alternatively, the histedit operation may be aborted which will leave
1040 the work tree switched back to its original branch.
1042 If a merge conflict is resolved in a way which renders the merged
1043 change into a no-op change, the corresponding commit will be elided
1044 when the histedit operation continues.
1047 will refuse to run if certain preconditions are not met.
1048 If the work tree's current branch is not in the
1050 reference namespace, the history of the branch may not be edited.
1051 If the work tree contains multiple base commits it must first be updated
1052 to a single base commit with
1054 If changes have been staged with
1056 these changes must first be committed with
1060 If the work tree contains local changes, these changes must first be
1065 If the edited history contains changes to files outside of the work tree's
1066 path prefix, the work tree cannot be used to edit the history of this branch.
1070 command will refuse to run while a histedit operation is in progress.
1071 Other commands which manipulate the work tree may be used, and the
1073 command may be used to commit arbitrary changes to the temporary branch
1074 while the histedit operation is interrupted.
1081 Abort an interrupted histedit operation.
1082 If this option is used, no other command-line arguments are allowed.
1084 Continue an interrupted histedit operation.
1085 If this option is used, no other command-line arguments are allowed.
1090 .It Cm integrate Ar branch
1091 Integrate the specified
1093 into the work tree's current branch.
1094 Files in the work tree are updated to match the contents on the integrated
1096 and the reference of the work tree's branch is changed to point at the
1097 head commit of the integrated
1100 Both branches can be considered equivalent after integration since they
1101 will be pointing at the same commit.
1102 Both branches remain available for future work, if desired.
1103 In case the integrated
1105 is no longer needed it may be deleted with
1108 Show the status of each affected file, using the following status codes:
1109 .Bl -column YXZ description
1110 .It U Ta file was updated
1111 .It D Ta file was deleted
1112 .It A Ta new file was added
1113 .It \(a~ Ta versioned file is obstructed by a non-regular file
1114 .It ! Ta a missing versioned file was restored
1118 will refuse to run if certain preconditions are not met.
1119 Most importantly, the
1121 must have been rebased onto the work tree's current branch with
1123 before it can be integrated, in order to linearize commit history and
1124 resolve merge conflicts.
1125 If the work tree contains multiple base commits it must first be updated
1126 to a single base commit with
1128 If changes have been staged with
1130 these changes must first be committed with
1134 If the work tree contains local changes, these changes must first be
1142 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1143 Stage local changes for inclusion in the next commit.
1146 is specified, stage all changes in the work tree.
1147 Otherwise, stage changes at or within the specified paths.
1148 Paths may be staged if they are added, modified, or deleted according to
1151 Show the status of each affected file, using the following status codes:
1152 .Bl -column YXZ description
1153 .It A Ta file addition has been staged
1154 .It M Ta file modification has been staged
1155 .It D Ta file deletion has been staged
1158 Staged file contents are saved in newly created blob objects in the repository.
1159 These blobs will be referred to by tree objects once staged changes have been
1162 Staged changes affect the behaviour of
1167 While paths with staged changes exist, the
1169 command will refuse to commit any paths which do not have staged changes.
1170 Local changes created on top of staged changes can only be committed if
1171 the path is staged again, or if the staged changes are committed first.
1174 command will show both local changes and staged changes.
1177 command is able to display local changes relative to staged changes,
1178 and to display staged changes relative to the repository.
1181 command cannot revert staged changes but may be used to revert
1182 local changes created on top of staged changes.
1189 Instead of staging new changes, list paths which are already staged,
1190 along with the IDs of staged blob objects and stage status codes.
1191 If paths were provided in the command line show the staged paths
1192 among the specified paths.
1193 Otherwise, show all staged paths.
1195 Instead of staging the entire content of a changed file, interactively
1196 select or reject changes for staging based on
1200 (reject change), and
1202 (quit staging this file) responses.
1203 If a file is in modified status, individual patches derived from the
1204 modified file content can be staged.
1205 Files in added or deleted status may only be staged or rejected in
1207 .It Fl F Ar response-script
1215 responses line-by-line from the specified
1217 file instead of prompting interactively.
1221 will refuse to run if certain preconditions are not met.
1222 If a file contains merge conflicts, these conflicts must be resolved first.
1223 If a file is found to be out of date relative to the head commit on the
1224 work tree's current branch, the file must be updated with
1226 before it can be staged (however, this does not prevent the file from
1227 becoming out-of-date at some point after having been staged).
1234 commands will refuse to run while staged changes exist.
1235 If staged changes cannot be committed because a staged path
1236 is out of date, the path must be unstaged with
1238 before it can be updated with
1240 and may then be staged again if necessary.
1244 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1245 Merge staged changes back into the work tree and put affected paths
1246 back into non-staged status.
1249 is specified, unstage all staged changes across the entire work tree.
1250 Otherwise, unstage changes at or within the specified paths.
1252 Show the status of each affected file, using the following status codes:
1253 .Bl -column YXZ description
1254 .It G Ta file was unstaged
1255 .It C Ta file was unstaged and conflicts occurred during merge
1256 .It ! Ta changes destined for a missing file were not merged
1257 .It D Ta file was staged as deleted and still is deleted
1258 .It d Ta file's deletion was obstructed by local modifications
1259 .It \(a~ Ta changes destined for a non-regular file were not merged
1267 Instead of unstaging the entire content of a changed file, interactively
1268 select or reject changes for unstaging based on
1272 (keep change staged), and
1274 (quit unstaging this file) responses.
1275 If a file is staged in modified status, individual patches derived from the
1276 staged file content can be unstaged.
1277 Files staged in added or deleted status may only be unstaged in their entirety.
1278 .It Fl F Ar response-script
1286 responses line-by-line from the specified
1288 file instead of prompting interactively.
1293 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1294 Parse and print contents of objects to standard output in a line-based
1296 Content of commit, tree, and tag objects is printed in a way similar
1297 to the actual content stored in such objects.
1298 Blob object contents are printed as they would appear in files on disk.
1300 Attempt to interpret each argument as a reference, a tag name, or
1301 an object ID SHA1 hash.
1302 References will be resolved to an object ID.
1303 Tag names will resolved to a tag object.
1304 An abbreviated hash argument will be expanded to a full SHA1 hash
1305 automatically, provided the abbreviation is unique.
1307 If none of the above interpretations produce a valid result, or if the
1309 option is used, attempt to interpret the argument as a path which will
1310 be resolved to the ID of an object found at this path in the repository.
1317 Look up paths in the specified
1319 If this option is not used, paths are looked up in the commit resolved
1320 via the repository's HEAD reference.
1321 The expected argument is a commit ID SHA1 hash or an existing reference
1322 or tag name which will be resolved to a commit ID.
1323 An abbreviated hash argument will be expanded to a full SHA1 hash
1324 automatically, provided the abbreviation is unique.
1325 .It Fl r Ar repository-path
1326 Use the repository at the specified path.
1327 If not specified, assume the repository is located at or above the current
1329 If this directory is a
1331 work tree, use the repository path associated with this work tree.
1333 Interpret all arguments as paths only.
1334 This option can be used to resolve ambiguity in cases where paths
1335 look like tag names, reference names, or object IDs.
1339 .Bl -tag -width GOT_AUTHOR
1341 The author's name and email address for
1346 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1349 may fail to parse commits without an email address in author data,
1353 environment variables with a missing email address.
1359 configuration settings in the repository's
1361 file will override the value of
1367 configuration settings contained in Git's global
1369 configuration file will be used only if the
1371 environment variable is
1374 .It Ev VISUAL , EDITOR
1375 The editor spawned by
1380 .It Ev GOT_LOG_DEFAULT_LIMIT
1381 The default limit on the number of commits traversed by
1383 If set to zero, the limit is unbounded.
1384 This variable will be silently ignored if it is set to a non-numeric value.
1389 Clone an existing Git repository for use with
1391 This step currently requires
1395 .Dl $ git clone --bare https://github.com/openbsd/src.git
1397 Alternatively, for quick and dirty local testing of
1399 a new Git repository could be created and populated with files,
1400 e.g. from a temporary CVS checkout located at
1403 .Dl $ got init /var/git/src.git
1404 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1406 Check out a work tree from the Git repository to /usr/src:
1408 .Dl $ got checkout /var/git/src.git /usr/src
1410 View local changes in a work tree directory:
1413 .Dl $ got diff | less
1415 Interactively revert selected local changes in a work tree directory:
1417 .Dl $ got revert -p -R\ .
1419 In a work tree or a git repository directory, list all branch references:
1423 In a work tree or a git repository directory, create a new branch called
1424 .Dq unified-buffer-cache
1425 which is forked off the
1429 .Dl $ got branch unified-buffer-cache master
1431 Switch an existing work tree to the branch
1432 .Dq unified-buffer-cache .
1433 Local changes in the work tree will be preserved and merged if necessary:
1435 .Dl $ got update -b unified-buffer-cache
1437 Create a new commit from local changes in a work tree directory.
1438 This new commit will become the head commit of the work tree's current branch:
1442 In a work tree or a git repository directory, view changes committed in
1443 the 3 most recent commits to the work tree's branch, or the branch resolved
1444 via the repository's HEAD reference, respectively:
1446 .Dl $ got log -p -l 3
1448 Add new files and remove obsolete files in a work tree directory:
1450 .Dl $ got add sys/uvm/uvm_ubc.c
1451 .Dl $ got remove sys/uvm/uvm_vnode.c
1453 Create a new commit from local changes in a work tree directory
1454 with a pre-defined log message.
1456 .Dl $ got commit -m 'unify the buffer cache'
1458 Update any work tree checked out from the
1459 .Dq unified-buffer-cache
1460 branch to the latest commit on this branch:
1464 Roll file content on the unified-buffer-cache branch back by one commit,
1465 and then fetch the rolled-back change into the work tree as a local change
1466 to be amended and perhaps committed again:
1468 .Dl $ got backout unified-buffer-cache
1469 .Dl $ got commit -m 'roll back previous'
1470 .Dl $ # now back out the previous backout :-)
1471 .Dl $ got backout unified-buffer-cache
1473 Fetch new upstream commits into the local repository's master branch.
1474 This step currently requires
1477 .Dl $ cd /var/git/src.git
1478 .Dl $ git fetch origin master:master
1481 .Dq unified-buffer-cache
1482 branch on top of the new head commit of the
1486 .Dl $ got update -b master
1487 .Dl $ got rebase unified-buffer-cache
1489 Create a patch from all changes on the unified-buffer-cache branch.
1490 The patch can be mailed out for review and applied to
1494 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1496 Edit the entire commit history of the
1497 .Dq unified-buffer-cache
1500 .Dl $ got update -b unified-buffer-cache
1501 .Dl $ got update -c master
1504 Additional steps are necessary if local changes need to be pushed back
1505 to the remote repository, which currently requires
1509 Before working against existing branches in a repository cloned with
1510 .Dq git clone --bare ,
1513 must be configured to map all references in the remote repository
1516 namespace of the local repository.
1517 This can achieved by setting Git's
1518 .Pa remote.origin.fetch
1519 configuration variable to the value
1520 .Dq +refs/heads/*:refs/remotes/origin/*
1525 .Dl $ cd /var/git/repo
1526 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1528 Alternatively, the following
1530 configuration item can be added manually to the Git repository's
1534 .Dl [remote "origin"]
1536 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1538 This configuration leaves the local repository's
1540 namespace free for use by local branches checked out with
1542 and, if needed, created with
1547 namespace can be updated with incoming changes from the remote
1551 .Dl $ cd /var/git/repo
1554 To make changes fetched from the remote repository appear on the
1558 branch must be rebased onto the
1561 This will also merge local changes, if any, with the incoming changes:
1563 .Dl $ got update -b origin/master
1564 .Dl $ got rebase master
1566 Local changes on the
1568 branch can then be pushed to the remote
1572 .Dl $ cd /var/git/repo
1573 .Dl $ git push origin master
1575 In order to merge changes committed to the
1576 .Dq unified-buffer-cache
1577 branch back into the
1580 .Dq unified-buffer-cache
1581 branch must first be rebased onto the
1585 .Dl $ got update -b master
1586 .Dl $ got rebase unified-buffer-cache
1589 .Dq unified-buffer-cache
1590 branch can now be made visible on the
1594 Because the rebase operation switched the work tree to the
1595 .Dq unified-buffer-cache
1596 branch, the work tree must be switched back to the
1599 .Dq unified-buffer-cache
1600 branch can be integrated into
1603 .Dl $ got update -b master
1604 .Dl $ got integrate unified-buffer-cache
1607 .Xr git-repository 5 ,
1610 .An Stefan Sperling Aq Mt stsp@openbsd.org
1611 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1612 .An Joshua Stein Aq Mt jcs@openbsd.org
1615 is a work-in-progress and many commands remain to be implemented.
1616 At present, the user has to fall back on
1618 to perform many tasks, in particular tasks related to repository
1619 administration and tasks which require a network connection.
