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 OcOo 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 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
329 Display history of a repository.
332 is specified, show only commits which modified this path.
339 Start traversing history at the specified
341 The expected argument is a commit ID SHA1 hash or an existing reference
342 or tag name which will be resolved to a commit ID.
343 An abbreviated hash argument will be expanded to a full SHA1 hash
344 automatically, provided the abbreviation is unique.
345 If this option is not specified, default to the work tree's current branch
346 if invoked in a work tree, or to the repository's HEAD reference.
348 Set the number of context lines shown in diffs with
350 By default, 3 lines of context are shown.
352 Restrict history traversal to the first parent of each commit.
353 This shows the linear history of the current branch only.
354 Merge commits which affected the current branch will be shown but
355 individual commits which originated on other branches will be omitted.
357 Limit history traversal to a given number of commits.
358 If this option is not specified, a default limit value of zero is used,
359 which is treated as an unbounded limit.
361 .Ev GOT_LOG_DEFAULT_LIMIT
362 environment variable may be set to change this default value.
364 Display the patch of modifications made in each commit.
367 is specified, only show the patch of modifications at or within this path.
368 .It Fl s Ar search-pattern
369 If specified, show only commits with a log message matched by the extended
372 Regular expression syntax is documented in
374 .It Fl r Ar repository-path
375 Use the repository at the specified path.
376 If not specified, assume the repository is located at or above the current
378 If this directory is a
380 work tree, use the repository path associated with this work tree.
382 .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
383 When invoked within a work tree with less than two arguments, display
384 uncommitted changes in the work tree.
387 is specified, only show changes within this path.
389 If two arguments are provided, treat each argument as a reference, a tag
390 name, or an object ID SHA1 hash, and display differences between the
391 corresponding objects.
392 Both objects must be of the same type (blobs, trees, or commits).
393 An abbreviated hash argument will be expanded to a full SHA1 hash
394 automatically, provided the abbreviation is unique.
401 Set the number of context lines shown in the diff.
402 By default, 3 lines of context are shown.
403 .It Fl r Ar repository-path
404 Use the repository at the specified path.
405 If not specified, assume the repository is located at or above the current
407 If this directory is a
409 work tree, use the repository path associated with this work tree.
411 Show changes staged with
413 instead of showing local changes.
414 This option is only valid when
416 is invoked in a work tree.
418 Ignore whitespace-only changes.
423 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
424 Display line-by-line history of a file at the specified path.
431 Start traversing history at the specified
433 The expected argument is a commit ID SHA1 hash or an existing reference
434 or tag name which will be resolved to a commit ID.
435 An abbreviated hash argument will be expanded to a full SHA1 hash
436 automatically, provided the abbreviation is unique.
437 .It Fl r Ar repository-path
438 Use the repository at the specified path.
439 If not specified, assume the repository is located at or above the current
441 If this directory is a
443 work tree, use the repository path associated with this work tree.
448 .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
449 Display a listing of files and directories at the specified
450 directory path in the repository.
451 Entries shown in this listing may carry one of the following trailing
453 .Bl -column YXZ description
454 .It @ Ta entry is a symbolic link
455 .It / Ta entry is a directory
456 .It * Ta entry is an executable file
457 .It $ Ta entry is a Git submodule
462 is specified, list the repository path corresponding to the current
463 directory of the work tree, or the root directory of the repository
464 if there is no work tree.
471 List files and directories as they appear in the specified
473 The expected argument is a commit ID SHA1 hash or an existing reference
474 or tag name which will be resolved to a commit ID.
475 An abbreviated hash argument will be expanded to a full SHA1 hash
476 automatically, provided the abbreviation is unique.
477 .It Fl r Ar repository-path
478 Use the repository at the specified path.
479 If not specified, assume the repository is located at or above the current
481 If this directory is a
483 work tree, use the repository path associated with this work tree.
485 Show object IDs of files (blob objects) and directories (tree objects).
487 Recurse into sub-directories in the repository.
492 .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
493 Manage references in a repository.
495 If no options are passed, expect two arguments and attempt to create,
496 or update, the reference with the given
498 and make it point at the given
500 The name must be an absolute reference name, i.e. it must begin with
502 The target may be an object ID SHA1 hash or an existing reference which
503 will be resolved to an object ID.
504 An abbreviated hash argument will be expanded to a full SHA1 hash
505 automatically, provided the abbreviation is unique.
511 .It Fl r Ar repository-path
512 Use the repository at the specified path.
513 If not specified, assume the repository is located at or above the current
515 If this directory is a
517 work tree, use the repository path associated with this work tree.
519 List all existing references in the repository.
521 Delete the reference with the specified name from the repository.
523 Create a symbolic reference pointing at the specified
525 which must be an existing reference.
526 Care should be taken not to create loops between references when
529 .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
530 Manage branches in a repository.
532 Branches are managed via references which live in the
537 command operates on references in this namespace only.
539 If invoked in a work tree without any arguments, print the name of the
540 work tree's current branch.
543 argument is passed, attempt to create a branch reference with the given name.
544 By default the new branch reference will point at the latest commit on the
545 work tree's current branch if invoked in a work tree, and otherwise to a commit
546 resolved via the repository's HEAD reference.
553 Make a newly created branch reference point at the specified
557 argument is a commit ID SHA1 hash or an existing reference
558 or tag name which will be resolved to a commit ID.
559 .It Fl r Ar repository-path
560 Use the repository at the specified path.
561 If not specified, assume the repository is located at or above the current
563 If this directory is a
565 work tree, use the repository path associated with this work tree.
567 List all existing branches in the repository.
568 If invoked in a work tree, the work tree's current branch is shown
569 with one the following annotations:
570 .Bl -column YXZ description
571 .It * Ta work tree's base commit matches the branch tip
572 .It \(a~ Ta work tree's base commit is out-of-date
575 Delete the branch with the specified name from the repository.
576 Only the branch reference is deleted.
577 Any commit, tree, and blob objects belonging to the branch
578 remain in the repository and may be removed separately with
579 Git's garbage collector.
584 .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
585 Manage tags in a repository.
587 Tags are managed via references which live in the
592 command operates on references in this namespace only.
593 References in this namespace point at tag objects which contain a pointer
594 to another object, a tag message, as well as author and timestamp information.
596 Expect one or two arguments and attempt to create a tag with the given
598 and make this tag point at the given
600 If no commit is specified, default to the latest commit on the work tree's
601 current branch if invoked in a work tree, and to a commit resolved via
602 the repository's HEAD reference otherwise.
603 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
604 reference or tag name which will be resolved to a commit ID.
605 An abbreviated hash argument will be expanded to a full SHA1 hash
606 automatically, provided the abbreviation is unique.
613 Use the specified tag message when creating the new tag
618 opens a temporary file in an editor where a tag message can be written.
619 .It Fl r Ar repository-path
620 Use the repository at the specified path.
621 If not specified, assume the repository is located at or above the current
623 If this directory is a
625 work tree, use the repository path associated with this work tree.
627 List all existing tags in the repository instead of creating a new tag.
628 If this option is used, no other command-line arguments are allowed.
633 command will not delete tags or change existing tags.
634 If a tag must be deleted, the
636 command may be used to delete a tag's reference.
637 This should only be done if the tag has not already been copied to
639 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
640 Schedule unversioned files in a work tree for addition to the
641 repository in the next commit.
648 Permit recursion into directories.
649 If this option is not specified,
651 will refuse to run if a specified
655 With -R, add files even if they match a
659 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
660 Remove versioned files from a work tree and schedule them for deletion
661 from the repository in the next commit.
668 Perform the operation even if a file contains uncommitted modifications.
670 Keep affected files on disk.
672 Permit recursion into directories.
673 If this option is not specified,
675 will refuse to run if a specified
682 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
683 Revert any uncommitted changes in files at the specified paths.
684 File contents will be overwritten with those contained in the
685 work tree's base commit.
686 There is no way to bring discarded changes back after
689 If a file was added with
691 it will become an unversioned file again.
692 If a file was deleted with
701 Instead of reverting all changes in files, interactively select or reject
702 changes to revert based on
708 (quit reverting this file) responses.
709 If a file is in modified status, individual patches derived from the
710 modified file content can be reverted.
711 Files in added or deleted status may only be reverted in their entirety.
712 .It Fl F Ar response-script
720 responses line-by-line from the specified
722 file instead of prompting interactively.
724 Permit recursion into directories.
725 If this option is not specified,
727 will refuse to run if a specified
734 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
735 Create a new commit in the repository from changes in a work tree
736 and use this commit as the new base commit for the work tree.
739 is specified, commit all changes in the work tree.
740 Otherwise, commit changes at or within the specified paths.
742 If changes have been explicitly staged for commit with
744 only commit staged changes and reject any specified paths which
745 have not been staged.
747 Show the status of each affected file, using the following status codes:
748 .Bl -column YXZ description
749 .It M Ta modified file
750 .It D Ta file was deleted
751 .It A Ta new file was added
752 .It m Ta modified file modes (executable bit only)
755 Files which are not part of the new commit will retain their previously
756 recorded base commit.
759 commands may refuse to run while the work tree contains files from
760 multiple base commits.
761 The base commit of such a work tree can be made consistent by running
763 across the entire work tree.
769 environment variable to be set,
774 configuration settings can be
775 obtained from the repository's
777 file or from Git's global
786 Use the specified log message when creating the new commit.
791 opens a temporary file in an editor where a log message can be written.
795 will refuse to run if certain preconditions are not met.
796 If the work tree's current branch is not in the
798 reference namespace, new commits may not be created on this branch.
799 Local changes may only be committed if they are based on file content
800 found in the most recent commit on the work tree's branch.
801 If a path is found to be out of date,
803 must be used first in order to merge local changes with changes made
808 .It Cm cherrypick Ar commit
809 Merge changes from a single
814 must be on a different branch than the work tree's base commit.
815 The expected argument is a reference or a commit ID SHA1 hash.
816 An abbreviated hash argument will be expanded to a full SHA1 hash
817 automatically, provided the abbreviation is unique.
819 Show the status of each affected file, using the following status codes:
820 .Bl -column YXZ description
821 .It G Ta file was merged
822 .It C Ta file was merged and conflicts occurred during merge
823 .It ! Ta changes destined for a missing file were not merged
824 .It D Ta file was deleted
825 .It d Ta file's deletion was obstructed by local modifications
826 .It A Ta new file was added
827 .It \(a~ Ta changes destined for a non-regular file were not merged
830 The merged changes will appear as local changes in the work tree, which
833 amended manually or with further
838 or discarded again with
842 will refuse to run if certain preconditions are not met.
843 If the work tree contains multiple base commits it must first be updated
844 to a single base commit with
846 If the work tree already contains files with merge conflicts, these
847 conflicts must be resolved first.
851 .It Cm backout Ar commit
852 Reverse-merge changes from a single
857 must be on the same branch as the work tree's base commit.
858 The expected argument is a reference or a commit ID SHA1 hash.
859 An abbreviated hash argument will be expanded to a full SHA1 hash
860 automatically, provided the abbreviation is unique.
862 Show the status of each affected file, using the following status codes:
863 .Bl -column YXZ description
864 .It G Ta file was merged
865 .It C Ta file was merged and conflicts occurred during merge
866 .It ! Ta changes destined for a missing file were not merged
867 .It D Ta file was deleted
868 .It d Ta file's deletion was obstructed by local modifications
869 .It A Ta new file was added
870 .It \(a~ Ta changes destined for a non-regular file were not merged
873 The reverse-merged changes will appear as local changes in the work tree,
874 which may be viewed with
876 amended manually or with further
881 or discarded again with
885 will refuse to run if certain preconditions are not met.
886 If the work tree contains multiple base commits it must first be updated
887 to a single base commit with
889 If the work tree already contains files with merge conflicts, these
890 conflicts must be resolved first.
894 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
895 Rebase commits on the specified
897 onto the tip of the current branch of the work tree.
900 must share common ancestry with the work tree's current branch.
901 Rebasing begins with the first descendant commit of the youngest
902 common ancestor commit shared by the specified
904 and the work tree's current branch, and stops once the tip commit
909 Rebased commits are accumulated on a temporary branch which the work tree
910 will remain switched to throughout the entire rebase operation.
911 Commits on this branch represent the same changes with the same log
912 messages as their counterparts on the original
914 but with different commit IDs.
915 Once rebasing has completed successfully, the temporary branch becomes
916 the new version of the specified
918 and the work tree is automatically switched to it.
920 While rebasing commits, show the status of each affected file,
921 using the following status codes:
922 .Bl -column YXZ description
923 .It G Ta file was merged
924 .It C Ta file was merged and conflicts occurred during merge
925 .It ! Ta changes destined for a missing file were not merged
926 .It D Ta file was deleted
927 .It d Ta file's deletion was obstructed by local modifications
928 .It A Ta new file was added
929 .It \(a~ Ta changes destined for a non-regular file were not merged
932 If merge conflicts occur the rebase operation is interrupted and may
933 be continued once conflicts have been resolved.
934 Alternatively, the rebase operation may be aborted which will leave
936 unmodified and the work tree switched back to its original branch.
938 If a merge conflict is resolved in a way which renders the merged
939 change into a no-op change, the corresponding commit will be elided
940 when the rebase operation continues.
943 will refuse to run if certain preconditions are not met.
944 If the work tree is not yet fully updated to the tip commit of its
945 branch then the work tree must first be updated with
947 If changes have been staged with
949 these changes must first be committed with
953 If the work tree contains local changes, these changes must first be
960 contains changes to files outside of the work tree's path prefix,
961 the work tree cannot be used to rebase this branch.
967 commands will refuse to run while a rebase operation is in progress.
968 Other commands which manipulate the work tree may be used for
969 conflict resolution purposes.
976 Abort an interrupted rebase operation.
977 If this option is used, no other command-line arguments are allowed.
979 Continue an interrupted rebase operation.
980 If this option is used, no other command-line arguments are allowed.
985 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
986 Edit commit history between the work tree's current base commit and
987 the tip commit of the work tree's current branch.
989 Editing of commit history is controlled via a
991 which can be edited interactively or passed on the command line.
992 The format of the histedit script is line-based.
993 Each line in the script begins with a command name, followed by
994 whitespace and an argument.
995 For most commands, the expected argument is a commit ID SHA1 hash.
996 Any remaining text on the line is ignored.
997 Lines which begin with the
999 character are ignored entirely.
1001 The available commands are as follows:
1002 .Bl -column YXZ pick-commit
1003 .It pick Ar commit Ta Use the specified commit as it is.
1004 .It edit Ar commit Ta Use the specified commit but once changes have been
1005 merged into the work tree interrupt the histedit operation for amending.
1006 .It fold Ar commit Ta Combine the specified commit with the next commit
1007 listed further below that will be used.
1008 .It drop Ar commit Ta Remove this commit from the edited history.
1009 .It mesg Ar log-message Ta Use the specified single-line log message for
1010 the commit on the previous line.
1011 If the log message argument is left empty, open an editor where a new
1012 log message can be written.
1015 Every commit in the history being edited must be mentioned in the script.
1016 Lines may be re-ordered to change the order of commits in the edited history.
1018 Edited commits are accumulated on a temporary branch which the work tree
1019 will remain switched to throughout the entire histedit operation.
1020 Once history editing has completed successfully, the temporary branch becomes
1021 the new version of the work tree's branch and the work tree is automatically
1024 While merging commits, show the status of each affected file,
1025 using the following status codes:
1026 .Bl -column YXZ description
1027 .It G Ta file was merged
1028 .It C Ta file was merged and conflicts occurred during merge
1029 .It ! Ta changes destined for a missing file were not merged
1030 .It D Ta file was deleted
1031 .It d Ta file's deletion was obstructed by local modifications
1032 .It A Ta new file was added
1033 .It \(a~ Ta changes destined for a non-regular file were not merged
1036 If merge conflicts occur the histedit operation is interrupted and may
1037 be continued once conflicts have been resolved.
1038 Alternatively, the histedit operation may be aborted which will leave
1039 the work tree switched back to its original branch.
1041 If a merge conflict is resolved in a way which renders the merged
1042 change into a no-op change, the corresponding commit will be elided
1043 when the histedit operation continues.
1046 will refuse to run if certain preconditions are not met.
1047 If the work tree's current branch is not in the
1049 reference namespace, the history of the branch may not be edited.
1050 If the work tree contains multiple base commits it must first be updated
1051 to a single base commit with
1053 If changes have been staged with
1055 these changes must first be committed with
1059 If the work tree contains local changes, these changes must first be
1064 If the edited history contains changes to files outside of the work tree's
1065 path prefix, the work tree cannot be used to edit the history of this branch.
1069 command will refuse to run while a histedit operation is in progress.
1070 Other commands which manipulate the work tree may be used, and the
1072 command may be used to commit arbitrary changes to the temporary branch
1073 while the histedit operation is interrupted.
1080 Abort an interrupted histedit operation.
1081 If this option is used, no other command-line arguments are allowed.
1083 Continue an interrupted histedit operation.
1084 If this option is used, no other command-line arguments are allowed.
1089 .It Cm integrate Ar branch
1090 Integrate the specified
1092 into the work tree's current branch.
1093 Files in the work tree are updated to match the contents on the integrated
1095 and the reference of the work tree's branch is changed to point at the
1096 head commit of the integrated
1099 Both branches can be considered equivalent after integration since they
1100 will be pointing at the same commit.
1101 Both branches remain available for future work, if desired.
1102 In case the integrated
1104 is no longer needed it may be deleted with
1107 Show the status of each affected file, using the following status codes:
1108 .Bl -column YXZ description
1109 .It U Ta file was updated
1110 .It D Ta file was deleted
1111 .It A Ta new file was added
1112 .It \(a~ Ta versioned file is obstructed by a non-regular file
1113 .It ! Ta a missing versioned file was restored
1117 will refuse to run if certain preconditions are not met.
1118 Most importantly, the
1120 must have been rebased onto the work tree's current branch with
1122 before it can be integrated, in order to linearize commit history and
1123 resolve merge conflicts.
1124 If the work tree contains multiple base commits it must first be updated
1125 to a single base commit with
1127 If changes have been staged with
1129 these changes must first be committed with
1133 If the work tree contains local changes, these changes must first be
1141 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1142 Stage local changes for inclusion in the next commit.
1145 is specified, stage all changes in the work tree.
1146 Otherwise, stage changes at or within the specified paths.
1147 Paths may be staged if they are added, modified, or deleted according to
1150 Show the status of each affected file, using the following status codes:
1151 .Bl -column YXZ description
1152 .It A Ta file addition has been staged
1153 .It M Ta file modification has been staged
1154 .It D Ta file deletion has been staged
1157 Staged file contents are saved in newly created blob objects in the repository.
1158 These blobs will be referred to by tree objects once staged changes have been
1161 Staged changes affect the behaviour of
1166 While paths with staged changes exist, the
1168 command will refuse to commit any paths which do not have staged changes.
1169 Local changes created on top of staged changes can only be committed if
1170 the path is staged again, or if the staged changes are committed first.
1173 command will show both local changes and staged changes.
1176 command is able to display local changes relative to staged changes,
1177 and to display staged changes relative to the repository.
1180 command cannot revert staged changes but may be used to revert
1181 local changes created on top of staged changes.
1188 Instead of staging new changes, list paths which are already staged,
1189 along with the IDs of staged blob objects and stage status codes.
1190 If paths were provided in the command line show the staged paths
1191 among the specified paths.
1192 Otherwise, show all staged paths.
1194 Instead of staging the entire content of a changed file, interactively
1195 select or reject changes for staging based on
1199 (reject change), and
1201 (quit staging this file) responses.
1202 If a file is in modified status, individual patches derived from the
1203 modified file content can be staged.
1204 Files in added or deleted status may only be staged or rejected in
1206 .It Fl F Ar response-script
1214 responses line-by-line from the specified
1216 file instead of prompting interactively.
1220 will refuse to run if certain preconditions are not met.
1221 If a file contains merge conflicts, these conflicts must be resolved first.
1222 If a file is found to be out of date relative to the head commit on the
1223 work tree's current branch, the file must be updated with
1225 before it can be staged (however, this does not prevent the file from
1226 becoming out-of-date at some point after having been staged).
1233 commands will refuse to run while staged changes exist.
1234 If staged changes cannot be committed because a staged path
1235 is out of date, the path must be unstaged with
1237 before it can be updated with
1239 and may then be staged again if necessary.
1243 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1244 Merge staged changes back into the work tree and put affected paths
1245 back into non-staged status.
1248 is specified, unstage all staged changes across the entire work tree.
1249 Otherwise, unstage changes at or within the specified paths.
1251 Show the status of each affected file, using the following status codes:
1252 .Bl -column YXZ description
1253 .It G Ta file was unstaged
1254 .It C Ta file was unstaged and conflicts occurred during merge
1255 .It ! Ta changes destined for a missing file were not merged
1256 .It D Ta file was staged as deleted and still is deleted
1257 .It d Ta file's deletion was obstructed by local modifications
1258 .It \(a~ Ta changes destined for a non-regular file were not merged
1266 Instead of unstaging the entire content of a changed file, interactively
1267 select or reject changes for unstaging based on
1271 (keep change staged), and
1273 (quit unstaging this file) responses.
1274 If a file is staged in modified status, individual patches derived from the
1275 staged file content can be unstaged.
1276 Files staged in added or deleted status may only be unstaged in their entirety.
1277 .It Fl F Ar response-script
1285 responses line-by-line from the specified
1287 file instead of prompting interactively.
1292 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1293 Parse and print contents of objects to standard output in a line-based
1295 Content of commit, tree, and tag objects is printed in a way similar
1296 to the actual content stored in such objects.
1297 Blob object contents are printed as they would appear in files on disk.
1299 Attempt to interpret each argument as a reference, a tag name, or
1300 an object ID SHA1 hash.
1301 References will be resolved to an object ID.
1302 Tag names will resolved to a tag object.
1303 An abbreviated hash argument will be expanded to a full SHA1 hash
1304 automatically, provided the abbreviation is unique.
1306 If none of the above interpretations produce a valid result, or if the
1308 option is used, attempt to interpret the argument as a path which will
1309 be resolved to the ID of an object found at this path in the repository.
1316 Look up paths in the specified
1318 If this option is not used, paths are looked up in the commit resolved
1319 via the repository's HEAD reference.
1320 The expected argument is a commit ID SHA1 hash or an existing reference
1321 or tag name which will be resolved to a commit ID.
1322 An abbreviated hash argument will be expanded to a full SHA1 hash
1323 automatically, provided the abbreviation is unique.
1324 .It Fl r Ar repository-path
1325 Use the repository at the specified path.
1326 If not specified, assume the repository is located at or above the current
1328 If this directory is a
1330 work tree, use the repository path associated with this work tree.
1332 Interpret all arguments as paths only.
1333 This option can be used to resolve ambiguity in cases where paths
1334 look like tag names, reference names, or object IDs.
1338 .Bl -tag -width GOT_AUTHOR
1340 The author's name and email address for
1345 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1348 may fail to parse commits without an email address in author data,
1352 environment variables with a missing email address.
1358 configuration settings in the repository's
1360 file will override the value of
1366 configuration settings contained in Git's global
1368 configuration file will be used only if the
1370 environment variable is
1373 .It Ev VISUAL , EDITOR
1374 The editor spawned by
1379 .It Ev GOT_LOG_DEFAULT_LIMIT
1380 The default limit on the number of commits traversed by
1382 If set to zero, the limit is unbounded.
1383 This variable will be silently ignored if it is set to a non-numeric value.
1388 Clone an existing Git repository for use with
1390 This step currently requires
1394 .Dl $ git clone --bare https://github.com/openbsd/src.git
1396 Alternatively, for quick and dirty local testing of
1398 a new Git repository could be created and populated with files,
1399 e.g. from a temporary CVS checkout located at
1402 .Dl $ got init /var/git/src.git
1403 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1405 Check out a work tree from the Git repository to /usr/src:
1407 .Dl $ got checkout /var/git/src.git /usr/src
1409 View local changes in a work tree directory:
1412 .Dl $ got diff | less
1414 Interactively revert selected local changes in a work tree directory:
1416 .Dl $ got revert -p -R\ .
1418 In a work tree or a git repository directory, list all branch references:
1422 In a work tree or a git repository directory, create a new branch called
1423 .Dq unified-buffer-cache
1424 which is forked off the
1428 .Dl $ got branch unified-buffer-cache master
1430 Switch an existing work tree to the branch
1431 .Dq unified-buffer-cache .
1432 Local changes in the work tree will be preserved and merged if necessary:
1434 .Dl $ got update -b unified-buffer-cache
1436 Create a new commit from local changes in a work tree directory.
1437 This new commit will become the head commit of the work tree's current branch:
1441 In a work tree or a git repository directory, view changes committed in
1442 the 3 most recent commits to the work tree's branch, or the branch resolved
1443 via the repository's HEAD reference, respectively:
1445 .Dl $ got log -p -l 3 -f
1447 Add new files and remove obsolete files in a work tree directory:
1449 .Dl $ got add sys/uvm/uvm_ubc.c
1450 .Dl $ got remove sys/uvm/uvm_vnode.c
1452 Create a new commit from local changes in a work tree directory
1453 with a pre-defined log message.
1455 .Dl $ got commit -m 'unify the buffer cache'
1457 Update any work tree checked out from the
1458 .Dq unified-buffer-cache
1459 branch to the latest commit on this branch:
1463 Roll file content on the unified-buffer-cache branch back by one commit,
1464 and then fetch the rolled-back change into the work tree as a local change
1465 to be amended and perhaps committed again:
1467 .Dl $ got backout unified-buffer-cache
1468 .Dl $ got commit -m 'roll back previous'
1469 .Dl $ # now back out the previous backout :-)
1470 .Dl $ got backout unified-buffer-cache
1472 Fetch new upstream commits into the local repository's master branch.
1473 This step currently requires
1476 .Dl $ cd /var/git/src.git
1477 .Dl $ git fetch origin master:master
1480 .Dq unified-buffer-cache
1481 branch on top of the new head commit of the
1485 .Dl $ got update -b master
1486 .Dl $ got rebase unified-buffer-cache
1488 Create a patch from all changes on the unified-buffer-cache branch.
1489 The patch can be mailed out for review and applied to
1493 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1495 Edit the entire commit history of the
1496 .Dq unified-buffer-cache
1499 .Dl $ got update -b unified-buffer-cache
1500 .Dl $ got update -c master
1503 Additional steps are necessary if local changes need to be pushed back
1504 to the remote repository, which currently requires
1508 Before working against existing branches in a repository cloned with
1509 .Dq git clone --bare ,
1512 must be configured to map all references in the remote repository
1515 namespace of the local repository.
1516 This can achieved by setting Git's
1517 .Pa remote.origin.fetch
1518 configuration variable to the value
1519 .Dq +refs/heads/*:refs/remotes/origin/*
1524 .Dl $ cd /var/git/repo
1525 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1527 Alternatively, the following
1529 configuration item can be added manually to the Git repository's
1533 .Dl [remote "origin"]
1535 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1537 This configuration leaves the local repository's
1539 namespace free for use by local branches checked out with
1541 and, if needed, created with
1546 namespace can be updated with incoming changes from the remote
1550 .Dl $ cd /var/git/repo
1553 Before outgoing changes on the local
1555 branch can be pushed to the remote repository, the local
1557 branch must be rebased onto the
1561 .Dl $ got update -b origin/master
1562 .Dl $ got rebase master
1564 Changes on the local
1566 branch can then be pushed to the remote
1570 .Dl $ cd /var/git/repo
1571 .Dl $ git push origin master
1573 In order to merge changes committed to the
1574 .Dq unified-buffer-cache
1575 branch back into the
1578 .Dq unified-buffer-cache
1579 branch must first be rebased onto the
1583 .Dl $ got update -b master
1584 .Dl $ got rebase unified-buffer-cache
1587 .Dq unified-buffer-cache
1588 branch can now be made visible on the
1592 Because the rebase operation switched the work tree to the
1593 .Dq unified-buffer-cache
1594 branch, the work tree must be switched back to the
1597 .Dq unified-buffer-cache
1598 branch can be integrated into
1601 .Dl $ got update -b master
1602 .Dl $ got integrate unified-buffer-cache
1605 .Xr git-repository 5 ,
1608 .An Stefan Sperling Aq Mt stsp@openbsd.org
1609 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1610 .An Joshua Stein Aq Mt jcs@openbsd.org
1613 is a work-in-progress and many commands remain to be implemented.
1614 At present, the user has to fall back on
1616 to perform many tasks, in particular tasks related to repository
1617 administration and tasks which require a network connection.
