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.
333 If invoked in a work tree, the
335 is interpreted relative to the current working directory,
336 and the work tree's path prefix is implicitly prepended.
337 Otherwise, the path is interpreted relative to the repository root.
344 Display individual commits which were merged into the current branch
348 shows the linear history of the current branch only.
350 Start traversing history at the specified
352 The expected argument is a commit ID SHA1 hash or an existing reference
353 or tag name which will be resolved to a commit ID.
354 An abbreviated hash argument will be expanded to a full SHA1 hash
355 automatically, provided the abbreviation is unique.
356 If this option is not specified, default to the work tree's current branch
357 if invoked in a work tree, or to the repository's HEAD reference.
359 Set the number of context lines shown in diffs with
361 By default, 3 lines of context are shown.
363 Limit history traversal to a given number of commits.
364 If this option is not specified, a default limit value of zero is used,
365 which is treated as an unbounded limit.
367 .Ev GOT_LOG_DEFAULT_LIMIT
368 environment variable may be set to change this default value.
370 Display the patch of modifications made in each commit.
373 is specified, only show the patch of modifications at or within this path.
374 .It Fl s Ar search-pattern
375 If specified, show only commits with a log message matched by the extended
378 Regular expression syntax is documented in
380 .It Fl r Ar repository-path
381 Use the repository at the specified path.
382 If not specified, assume the repository is located at or above the current
384 If this directory is a
386 work tree, use the repository path associated with this work tree.
388 .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
389 When invoked within a work tree with less than two arguments, display
390 uncommitted changes in the work tree.
393 is specified, only show changes within this path.
395 If two arguments are provided, treat each argument as a reference, a tag
396 name, or an object ID SHA1 hash, and display differences between the
397 corresponding objects.
398 Both objects must be of the same type (blobs, trees, or commits).
399 An abbreviated hash argument will be expanded to a full SHA1 hash
400 automatically, provided the abbreviation is unique.
407 Set the number of context lines shown in the diff.
408 By default, 3 lines of context are shown.
409 .It Fl r Ar repository-path
410 Use the repository at the specified path.
411 If not specified, assume the repository is located at or above the current
413 If this directory is a
415 work tree, use the repository path associated with this work tree.
417 Show changes staged with
419 instead of showing local changes.
420 This option is only valid when
422 is invoked in a work tree.
424 Ignore whitespace-only changes.
429 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
430 Display line-by-line history of a file at the specified path.
437 Start traversing history at the specified
439 The expected argument is a commit ID SHA1 hash or an existing reference
440 or tag name which will be resolved to a commit ID.
441 An abbreviated hash argument will be expanded to a full SHA1 hash
442 automatically, provided the abbreviation is unique.
443 .It Fl r Ar repository-path
444 Use the repository at the specified path.
445 If not specified, assume the repository is located at or above the current
447 If this directory is a
449 work tree, use the repository path associated with this work tree.
454 .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
455 Display a listing of files and directories at the specified
456 directory path in the repository.
457 Entries shown in this listing may carry one of the following trailing
459 .Bl -column YXZ description
460 .It @ Ta entry is a symbolic link
461 .It / Ta entry is a directory
462 .It * Ta entry is an executable file
463 .It $ Ta entry is a Git submodule
468 is specified, list the repository path corresponding to the current
469 directory of the work tree, or the root directory of the repository
470 if there is no work tree.
477 List files and directories as they appear in the specified
479 The expected argument is a commit ID SHA1 hash or an existing reference
480 or tag name which will be resolved to a commit ID.
481 An abbreviated hash argument will be expanded to a full SHA1 hash
482 automatically, provided the abbreviation is unique.
483 .It Fl r Ar repository-path
484 Use the repository at the specified path.
485 If not specified, assume the repository is located at or above the current
487 If this directory is a
489 work tree, use the repository path associated with this work tree.
491 Show object IDs of files (blob objects) and directories (tree objects).
493 Recurse into sub-directories in the repository.
498 .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
499 Manage references in a repository.
501 If no options are passed, expect two arguments and attempt to create,
502 or update, the reference with the given
504 and make it point at the given
506 The name must be an absolute reference name, i.e. it must begin with
508 The target may be an object ID SHA1 hash or an existing reference which
509 will be resolved to an object ID.
510 An abbreviated hash argument will be expanded to a full SHA1 hash
511 automatically, provided the abbreviation is unique.
517 .It Fl r Ar repository-path
518 Use the repository at the specified path.
519 If not specified, assume the repository is located at or above the current
521 If this directory is a
523 work tree, use the repository path associated with this work tree.
525 List all existing references in the repository.
527 Delete the reference with the specified name from the repository.
529 Create a symbolic reference pointing at the specified
531 which must be an existing reference.
532 Care should be taken not to create loops between references when
535 .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
536 Manage branches in a repository.
538 Branches are managed via references which live in the
543 command operates on references in this namespace only.
545 If invoked in a work tree without any arguments, print the name of the
546 work tree's current branch.
549 argument is passed, attempt to create a branch reference with the given name.
550 By default the new branch reference will point at the latest commit on the
551 work tree's current branch if invoked in a work tree, and otherwise to a commit
552 resolved via the repository's HEAD reference.
559 Make a newly created branch reference point at the specified
563 argument is a commit ID SHA1 hash or an existing reference
564 or tag name which will be resolved to a commit ID.
565 .It Fl r Ar repository-path
566 Use the repository at the specified path.
567 If not specified, assume the repository is located at or above the current
569 If this directory is a
571 work tree, use the repository path associated with this work tree.
573 List all existing branches in the repository.
574 If invoked in a work tree, the work tree's current branch is shown
575 with one the following annotations:
576 .Bl -column YXZ description
577 .It * Ta work tree's base commit matches the branch tip
578 .It \(a~ Ta work tree's base commit is out-of-date
581 Delete the branch with the specified name from the repository.
582 Only the branch reference is deleted.
583 Any commit, tree, and blob objects belonging to the branch
584 remain in the repository and may be removed separately with
585 Git's garbage collector.
590 .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
591 Manage tags in a repository.
593 Tags are managed via references which live in the
598 command operates on references in this namespace only.
599 References in this namespace point at tag objects which contain a pointer
600 to another object, a tag message, as well as author and timestamp information.
602 Expect one or two arguments and attempt to create a tag with the given
604 and make this tag point at the given
606 If no commit is specified, default to the latest commit on the work tree's
607 current branch if invoked in a work tree, and to a commit resolved via
608 the repository's HEAD reference otherwise.
609 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
610 reference or tag name which will be resolved to a commit ID.
611 An abbreviated hash argument will be expanded to a full SHA1 hash
612 automatically, provided the abbreviation is unique.
619 Use the specified tag message when creating the new tag
624 opens a temporary file in an editor where a tag message can be written.
625 .It Fl r Ar repository-path
626 Use the repository at the specified path.
627 If not specified, assume the repository is located at or above the current
629 If this directory is a
631 work tree, use the repository path associated with this work tree.
633 List all existing tags in the repository instead of creating a new tag.
634 If this option is used, no other command-line arguments are allowed.
639 command will not delete tags or change existing tags.
640 If a tag must be deleted, the
642 command may be used to delete a tag's reference.
643 This should only be done if the tag has not already been copied to
645 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
646 Schedule unversioned files in a work tree for addition to the
647 repository in the next commit.
654 Permit recursion into directories.
655 If this option is not specified,
657 will refuse to run if a specified
661 With -R, add files even if they match a
665 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
666 Remove versioned files from a work tree and schedule them for deletion
667 from the repository in the next commit.
674 Perform the operation even if a file contains uncommitted modifications.
676 Keep affected files on disk.
678 Permit recursion into directories.
679 If this option is not specified,
681 will refuse to run if a specified
688 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
689 Revert any uncommitted changes in files at the specified paths.
690 File contents will be overwritten with those contained in the
691 work tree's base commit.
692 There is no way to bring discarded changes back after
695 If a file was added with
697 it will become an unversioned file again.
698 If a file was deleted with
707 Instead of reverting all changes in files, interactively select or reject
708 changes to revert based on
714 (quit reverting this file) responses.
715 If a file is in modified status, individual patches derived from the
716 modified file content can be reverted.
717 Files in added or deleted status may only be reverted in their entirety.
718 .It Fl F Ar response-script
726 responses line-by-line from the specified
728 file instead of prompting interactively.
730 Permit recursion into directories.
731 If this option is not specified,
733 will refuse to run if a specified
740 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
741 Create a new commit in the repository from changes in a work tree
742 and use this commit as the new base commit for the work tree.
745 is specified, commit all changes in the work tree.
746 Otherwise, commit changes at or within the specified paths.
748 If changes have been explicitly staged for commit with
750 only commit staged changes and reject any specified paths which
751 have not been staged.
753 Show the status of each affected file, using the following status codes:
754 .Bl -column YXZ description
755 .It M Ta modified file
756 .It D Ta file was deleted
757 .It A Ta new file was added
758 .It m Ta modified file modes (executable bit only)
761 Files which are not part of the new commit will retain their previously
762 recorded base commit.
765 commands may refuse to run while the work tree contains files from
766 multiple base commits.
767 The base commit of such a work tree can be made consistent by running
769 across the entire work tree.
775 environment variable to be set,
780 configuration settings can be
781 obtained from the repository's
783 file or from Git's global
792 Use the specified log message when creating the new commit.
797 opens a temporary file in an editor where a log message can be written.
801 will refuse to run if certain preconditions are not met.
802 If the work tree's current branch is not in the
804 reference namespace, new commits may not be created on this branch.
805 Local changes may only be committed if they are based on file content
806 found in the most recent commit on the work tree's branch.
807 If a path is found to be out of date,
809 must be used first in order to merge local changes with changes made
814 .It Cm cherrypick Ar commit
815 Merge changes from a single
820 must be on a different branch than the work tree's base commit.
821 The expected argument is a reference or a commit ID SHA1 hash.
822 An abbreviated hash argument will be expanded to a full SHA1 hash
823 automatically, provided the abbreviation is unique.
825 Show the status of each affected file, using the following status codes:
826 .Bl -column YXZ description
827 .It G Ta file was merged
828 .It C Ta file was merged and conflicts occurred during merge
829 .It ! Ta changes destined for a missing file were not merged
830 .It D Ta file was deleted
831 .It d Ta file's deletion was obstructed by local modifications
832 .It A Ta new file was added
833 .It \(a~ Ta changes destined for a non-regular file were not merged
836 The merged changes will appear as local changes in the work tree, which
839 amended manually or with further
844 or discarded again with
848 will refuse to run if certain preconditions are not met.
849 If the work tree contains multiple base commits it must first be updated
850 to a single base commit with
852 If the work tree already contains files with merge conflicts, these
853 conflicts must be resolved first.
857 .It Cm backout Ar commit
858 Reverse-merge changes from a single
863 must be on the same branch as the work tree's base commit.
864 The expected argument is a reference or a commit ID SHA1 hash.
865 An abbreviated hash argument will be expanded to a full SHA1 hash
866 automatically, provided the abbreviation is unique.
868 Show the status of each affected file, using the following status codes:
869 .Bl -column YXZ description
870 .It G Ta file was merged
871 .It C Ta file was merged and conflicts occurred during merge
872 .It ! Ta changes destined for a missing file were not merged
873 .It D Ta file was deleted
874 .It d Ta file's deletion was obstructed by local modifications
875 .It A Ta new file was added
876 .It \(a~ Ta changes destined for a non-regular file were not merged
879 The reverse-merged changes will appear as local changes in the work tree,
880 which may be viewed with
882 amended manually or with further
887 or discarded again with
891 will refuse to run if certain preconditions are not met.
892 If the work tree contains multiple base commits it must first be updated
893 to a single base commit with
895 If the work tree already contains files with merge conflicts, these
896 conflicts must be resolved first.
900 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
901 Rebase commits on the specified
903 onto the tip of the current branch of the work tree.
906 must share common ancestry with the work tree's current branch.
907 Rebasing begins with the first descendant commit of the youngest
908 common ancestor commit shared by the specified
910 and the work tree's current branch, and stops once the tip commit
915 Rebased commits are accumulated on a temporary branch which the work tree
916 will remain switched to throughout the entire rebase operation.
917 Commits on this branch represent the same changes with the same log
918 messages as their counterparts on the original
920 but with different commit IDs.
921 Once rebasing has completed successfully, the temporary branch becomes
922 the new version of the specified
924 and the work tree is automatically switched to it.
926 While rebasing commits, show the status of each affected file,
927 using the following status codes:
928 .Bl -column YXZ description
929 .It G Ta file was merged
930 .It C Ta file was merged and conflicts occurred during merge
931 .It ! Ta changes destined for a missing file were not merged
932 .It D Ta file was deleted
933 .It d Ta file's deletion was obstructed by local modifications
934 .It A Ta new file was added
935 .It \(a~ Ta changes destined for a non-regular file were not merged
938 If merge conflicts occur the rebase operation is interrupted and may
939 be continued once conflicts have been resolved.
940 Alternatively, the rebase operation may be aborted which will leave
942 unmodified and the work tree switched back to its original branch.
944 If a merge conflict is resolved in a way which renders the merged
945 change into a no-op change, the corresponding commit will be elided
946 when the rebase operation continues.
949 will refuse to run if certain preconditions are not met.
950 If the work tree is not yet fully updated to the tip commit of its
951 branch then the work tree must first be updated with
953 If changes have been staged with
955 these changes must first be committed with
959 If the work tree contains local changes, these changes must first be
966 contains changes to files outside of the work tree's path prefix,
967 the work tree cannot be used to rebase this branch.
973 commands will refuse to run while a rebase operation is in progress.
974 Other commands which manipulate the work tree may be used for
975 conflict resolution purposes.
982 Abort an interrupted rebase operation.
983 If this option is used, no other command-line arguments are allowed.
985 Continue an interrupted rebase operation.
986 If this option is used, no other command-line arguments are allowed.
991 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
992 Edit commit history between the work tree's current base commit and
993 the tip commit of the work tree's current branch.
995 Editing of commit history is controlled via a
997 which can be edited interactively, passed on the command line,
998 or generated with the
1000 option if only log messages need to be edited.
1002 The format of the histedit script is line-based.
1003 Each line in the script begins with a command name, followed by
1004 whitespace and an argument.
1005 For most commands, the expected argument is a commit ID SHA1 hash.
1006 Any remaining text on the line is ignored.
1007 Lines which begin with the
1009 character are ignored entirely.
1011 The available commands are as follows:
1012 .Bl -column YXZ pick-commit
1013 .It pick Ar commit Ta Use the specified commit as it is.
1014 .It edit Ar commit Ta Use the specified commit but once changes have been
1015 merged into the work tree interrupt the histedit operation for amending.
1016 .It fold Ar commit Ta Combine the specified commit with the next commit
1017 listed further below that will be used.
1018 .It drop Ar commit Ta Remove this commit from the edited history.
1019 .It mesg Ar log-message Ta Use the specified single-line log message for
1020 the commit on the previous line.
1021 If the log message argument is left empty, open an editor where a new
1022 log message can be written.
1025 Every commit in the history being edited must be mentioned in the script.
1026 Lines may be re-ordered to change the order of commits in the edited history.
1028 Edited commits are accumulated on a temporary branch which the work tree
1029 will remain switched to throughout the entire histedit operation.
1030 Once history editing has completed successfully, the temporary branch becomes
1031 the new version of the work tree's branch and the work tree is automatically
1034 While merging commits, show the status of each affected file,
1035 using the following status codes:
1036 .Bl -column YXZ description
1037 .It G Ta file was merged
1038 .It C Ta file was merged and conflicts occurred during merge
1039 .It ! Ta changes destined for a missing file were not merged
1040 .It D Ta file was deleted
1041 .It d Ta file's deletion was obstructed by local modifications
1042 .It A Ta new file was added
1043 .It \(a~ Ta changes destined for a non-regular file were not merged
1046 If merge conflicts occur the histedit operation is interrupted and may
1047 be continued once conflicts have been resolved.
1048 Alternatively, the histedit operation may be aborted which will leave
1049 the work tree switched back to its original branch.
1051 If a merge conflict is resolved in a way which renders the merged
1052 change into a no-op change, the corresponding commit will be elided
1053 when the histedit operation continues.
1056 will refuse to run if certain preconditions are not met.
1057 If the work tree's current branch is not in the
1059 reference namespace, the history of the branch may not be edited.
1060 If the work tree contains multiple base commits it must first be updated
1061 to a single base commit with
1063 If changes have been staged with
1065 these changes must first be committed with
1069 If the work tree contains local changes, these changes must first be
1074 If the edited history contains changes to files outside of the work tree's
1075 path prefix, the work tree cannot be used to edit the history of this branch.
1079 command will refuse to run while a histedit operation is in progress.
1080 Other commands which manipulate the work tree may be used, and the
1082 command may be used to commit arbitrary changes to the temporary branch
1083 while the histedit operation is interrupted.
1090 Abort an interrupted histedit operation.
1091 If this option is used, no other command-line arguments are allowed.
1093 Continue an interrupted histedit operation.
1094 If this option is used, no other command-line arguments are allowed.
1096 Edit log messages only.
1097 This option is a quick equivalent to a histedit script which edits
1098 only log messages but otherwise leaves every picked commit as-is.
1101 option can only be used when starting a new histedit operation.
1102 If this option is used, no other command-line arguments are allowed.
1107 .It Cm integrate Ar branch
1108 Integrate the specified
1110 into the work tree's current branch.
1111 Files in the work tree are updated to match the contents on the integrated
1113 and the reference of the work tree's branch is changed to point at the
1114 head commit of the integrated
1117 Both branches can be considered equivalent after integration since they
1118 will be pointing at the same commit.
1119 Both branches remain available for future work, if desired.
1120 In case the integrated
1122 is no longer needed it may be deleted with
1125 Show the status of each affected file, using the following status codes:
1126 .Bl -column YXZ description
1127 .It U Ta file was updated
1128 .It D Ta file was deleted
1129 .It A Ta new file was added
1130 .It \(a~ Ta versioned file is obstructed by a non-regular file
1131 .It ! Ta a missing versioned file was restored
1135 will refuse to run if certain preconditions are not met.
1136 Most importantly, the
1138 must have been rebased onto the work tree's current branch with
1140 before it can be integrated, in order to linearize commit history and
1141 resolve merge conflicts.
1142 If the work tree contains multiple base commits it must first be updated
1143 to a single base commit with
1145 If changes have been staged with
1147 these changes must first be committed with
1151 If the work tree contains local changes, these changes must first be
1159 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1160 Stage local changes for inclusion in the next commit.
1163 is specified, stage all changes in the work tree.
1164 Otherwise, stage changes at or within the specified paths.
1165 Paths may be staged if they are added, modified, or deleted according to
1168 Show the status of each affected file, using the following status codes:
1169 .Bl -column YXZ description
1170 .It A Ta file addition has been staged
1171 .It M Ta file modification has been staged
1172 .It D Ta file deletion has been staged
1175 Staged file contents are saved in newly created blob objects in the repository.
1176 These blobs will be referred to by tree objects once staged changes have been
1179 Staged changes affect the behaviour of
1184 While paths with staged changes exist, the
1186 command will refuse to commit any paths which do not have staged changes.
1187 Local changes created on top of staged changes can only be committed if
1188 the path is staged again, or if the staged changes are committed first.
1191 command will show both local changes and staged changes.
1194 command is able to display local changes relative to staged changes,
1195 and to display staged changes relative to the repository.
1198 command cannot revert staged changes but may be used to revert
1199 local changes created on top of staged changes.
1206 Instead of staging new changes, list paths which are already staged,
1207 along with the IDs of staged blob objects and stage status codes.
1208 If paths were provided in the command line show the staged paths
1209 among the specified paths.
1210 Otherwise, show all staged paths.
1212 Instead of staging the entire content of a changed file, interactively
1213 select or reject changes for staging based on
1217 (reject change), and
1219 (quit staging this file) responses.
1220 If a file is in modified status, individual patches derived from the
1221 modified file content can be staged.
1222 Files in added or deleted status may only be staged or rejected in
1224 .It Fl F Ar response-script
1232 responses line-by-line from the specified
1234 file instead of prompting interactively.
1238 will refuse to run if certain preconditions are not met.
1239 If a file contains merge conflicts, these conflicts must be resolved first.
1240 If a file is found to be out of date relative to the head commit on the
1241 work tree's current branch, the file must be updated with
1243 before it can be staged (however, this does not prevent the file from
1244 becoming out-of-date at some point after having been staged).
1251 commands will refuse to run while staged changes exist.
1252 If staged changes cannot be committed because a staged path
1253 is out of date, the path must be unstaged with
1255 before it can be updated with
1257 and may then be staged again if necessary.
1261 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1262 Merge staged changes back into the work tree and put affected paths
1263 back into non-staged status.
1266 is specified, unstage all staged changes across the entire work tree.
1267 Otherwise, unstage changes at or within the specified paths.
1269 Show the status of each affected file, using the following status codes:
1270 .Bl -column YXZ description
1271 .It G Ta file was unstaged
1272 .It C Ta file was unstaged and conflicts occurred during merge
1273 .It ! Ta changes destined for a missing file were not merged
1274 .It D Ta file was staged as deleted and still is deleted
1275 .It d Ta file's deletion was obstructed by local modifications
1276 .It \(a~ Ta changes destined for a non-regular file were not merged
1284 Instead of unstaging the entire content of a changed file, interactively
1285 select or reject changes for unstaging based on
1289 (keep change staged), and
1291 (quit unstaging this file) responses.
1292 If a file is staged in modified status, individual patches derived from the
1293 staged file content can be unstaged.
1294 Files staged in added or deleted status may only be unstaged in their entirety.
1295 .It Fl F Ar response-script
1303 responses line-by-line from the specified
1305 file instead of prompting interactively.
1310 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1311 Parse and print contents of objects to standard output in a line-based
1313 Content of commit, tree, and tag objects is printed in a way similar
1314 to the actual content stored in such objects.
1315 Blob object contents are printed as they would appear in files on disk.
1317 Attempt to interpret each argument as a reference, a tag name, or
1318 an object ID SHA1 hash.
1319 References will be resolved to an object ID.
1320 Tag names will resolved to a tag object.
1321 An abbreviated hash argument will be expanded to a full SHA1 hash
1322 automatically, provided the abbreviation is unique.
1324 If none of the above interpretations produce a valid result, or if the
1326 option is used, attempt to interpret the argument as a path which will
1327 be resolved to the ID of an object found at this path in the repository.
1334 Look up paths in the specified
1336 If this option is not used, paths are looked up in the commit resolved
1337 via the repository's HEAD reference.
1338 The expected argument is a commit ID SHA1 hash or an existing reference
1339 or tag name which will be resolved to a commit ID.
1340 An abbreviated hash argument will be expanded to a full SHA1 hash
1341 automatically, provided the abbreviation is unique.
1342 .It Fl r Ar repository-path
1343 Use the repository at the specified path.
1344 If not specified, assume the repository is located at or above the current
1346 If this directory is a
1348 work tree, use the repository path associated with this work tree.
1350 Interpret all arguments as paths only.
1351 This option can be used to resolve ambiguity in cases where paths
1352 look like tag names, reference names, or object IDs.
1356 .Bl -tag -width GOT_AUTHOR
1358 The author's name and email address for
1363 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1366 may fail to parse commits without an email address in author data,
1370 environment variables with a missing email address.
1376 configuration settings in the repository's
1378 file will override the value of
1384 configuration settings contained in Git's global
1386 configuration file will be used only if the
1388 environment variable is
1391 .It Ev VISUAL , EDITOR
1392 The editor spawned by
1397 .It Ev GOT_LOG_DEFAULT_LIMIT
1398 The default limit on the number of commits traversed by
1400 If set to zero, the limit is unbounded.
1401 This variable will be silently ignored if it is set to a non-numeric value.
1406 Clone an existing Git repository for use with
1408 This step currently requires
1412 .Dl $ git clone --bare https://github.com/openbsd/src.git
1414 Alternatively, for quick and dirty local testing of
1416 a new Git repository could be created and populated with files,
1417 e.g. from a temporary CVS checkout located at
1420 .Dl $ got init /var/git/src.git
1421 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1423 Check out a work tree from the Git repository to /usr/src:
1425 .Dl $ got checkout /var/git/src.git /usr/src
1427 View local changes in a work tree directory:
1430 .Dl $ got diff | less
1432 Interactively revert selected local changes in a work tree directory:
1434 .Dl $ got revert -p -R\ .
1436 In a work tree or a git repository directory, list all branch references:
1440 In a work tree or a git repository directory, create a new branch called
1441 .Dq unified-buffer-cache
1442 which is forked off the
1446 .Dl $ got branch unified-buffer-cache master
1448 Switch an existing work tree to the branch
1449 .Dq unified-buffer-cache .
1450 Local changes in the work tree will be preserved and merged if necessary:
1452 .Dl $ got update -b unified-buffer-cache
1454 Create a new commit from local changes in a work tree directory.
1455 This new commit will become the head commit of the work tree's current branch:
1459 In a work tree or a git repository directory, view changes committed in
1460 the 3 most recent commits to the work tree's branch, or the branch resolved
1461 via the repository's HEAD reference, respectively:
1463 .Dl $ got log -p -l 3
1465 In a work tree or a git repository directory, log the history of a subdirectory:
1467 .Dl $ got log sys/uvm
1469 While operating inside a work tree, paths are specified relative to the current
1470 working directory, so this command will log the subdirectory
1473 .Dl $ cd sys/uvm && got log '.'
1475 And this command has the same effect:
1477 .Dl $ cd sys/dev/usb && got log ../../uvm
1479 Add new files and remove obsolete files in a work tree directory:
1481 .Dl $ got add sys/uvm/uvm_ubc.c
1482 .Dl $ got remove sys/uvm/uvm_vnode.c
1484 Create a new commit from local changes in a work tree directory
1485 with a pre-defined log message.
1487 .Dl $ got commit -m 'unify the buffer cache'
1489 Update any work tree checked out from the
1490 .Dq unified-buffer-cache
1491 branch to the latest commit on this branch:
1495 Roll file content on the unified-buffer-cache branch back by one commit,
1496 and then fetch the rolled-back change into the work tree as a local change
1497 to be amended and perhaps committed again:
1499 .Dl $ got backout unified-buffer-cache
1500 .Dl $ got commit -m 'roll back previous'
1501 .Dl $ # now back out the previous backout :-)
1502 .Dl $ got backout unified-buffer-cache
1504 Fetch new upstream commits into the local repository's master branch.
1505 This step currently requires
1508 .Dl $ cd /var/git/src.git
1509 .Dl $ git fetch origin master:master
1512 .Dq unified-buffer-cache
1513 branch on top of the new head commit of the
1517 .Dl $ got update -b master
1518 .Dl $ got rebase unified-buffer-cache
1520 Create a patch from all changes on the unified-buffer-cache branch.
1521 The patch can be mailed out for review and applied to
1525 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1527 Edit the entire commit history of the
1528 .Dq unified-buffer-cache
1531 .Dl $ got update -b unified-buffer-cache
1532 .Dl $ got update -c master
1535 Additional steps are necessary if local changes need to be pushed back
1536 to the remote repository, which currently requires
1540 Before working against existing branches in a repository cloned with
1541 .Dq git clone --bare ,
1544 must be configured to map all references in the remote repository
1547 namespace of the local repository.
1548 This can achieved by setting Git's
1549 .Pa remote.origin.fetch
1550 configuration variable to the value
1551 .Dq +refs/heads/*:refs/remotes/origin/*
1556 .Dl $ cd /var/git/repo
1557 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1559 Alternatively, the following
1561 configuration item can be added manually to the Git repository's
1565 .Dl [remote "origin"]
1567 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1569 This configuration leaves the local repository's
1571 namespace free for use by local branches checked out with
1573 and, if needed, created with
1578 namespace can be updated with incoming changes from the remote
1582 .Dl $ cd /var/git/repo
1585 To make changes fetched from the remote repository appear on the
1589 branch must be rebased onto the
1592 This will also merge local changes, if any, with the incoming changes:
1594 .Dl $ got update -b origin/master
1595 .Dl $ got rebase master
1599 branch, log messages for local changes can now be amended with
1601 by other developers and any other important new information:
1603 .Dl $ got update -c origin/master
1604 .Dl $ got histedit -m
1606 Local changes on the
1608 branch can then be pushed to the remote
1612 .Dl $ cd /var/git/repo
1613 .Dl $ git push origin master
1615 In order to merge changes committed to the
1616 .Dq unified-buffer-cache
1617 branch back into the
1620 .Dq unified-buffer-cache
1621 branch must first be rebased onto the
1625 .Dl $ got update -b master
1626 .Dl $ got rebase unified-buffer-cache
1629 .Dq unified-buffer-cache
1630 branch can now be made visible on the
1634 Because the rebase operation switched the work tree to the
1635 .Dq unified-buffer-cache
1636 branch, the work tree must be switched back to the
1639 .Dq unified-buffer-cache
1640 branch can be integrated into
1643 .Dl $ got update -b master
1644 .Dl $ got integrate unified-buffer-cache
1647 .Xr git-repository 5 ,
1650 .An Stefan Sperling Aq Mt stsp@openbsd.org
1651 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1652 .An Joshua Stein Aq Mt jcs@openbsd.org
1655 is a work-in-progress and many commands remain to be implemented.
1656 At present, the user has to fall back on
1658 to perform many tasks, in particular tasks related to repository
1659 administration and tasks which require a network connection.
