2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
65 .It Cm init Ar repository-path
66 Create a new empty repository at the specified
73 command must be used to populate the empty repository before
79 .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
80 Create an initial commit in a repository from the file hierarchy
83 The created commit will not have any parent commits, i.e. it will be a
85 Also create a new reference which provides a branch name for the newly
87 Show the path of each imported file to indicate progress.
93 environment variable to be set.
102 instead of creating the default branch
104 Use of this option is required if the
106 branch already exists.
108 Use the specified log message when creating the new commit.
113 opens a temporary file in an editor where a log message can be written.
114 .It Fl r Ar repository-path
115 Use the repository at the specified path.
116 If not specified, assume the repository is located at or above the current
119 Ignore files or directories with a name which matches the specified
121 This option may be specified multiple times to build a list of ignore patterns.
124 follows the globbing rules documented in
130 .It Cm checkout Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
131 Copy files from a repository into a new work tree.
134 is not specified, either use the last component of
135 .Ar repository path ,
138 was specified use the last component of
146 Check out files from a commit on the specified
148 If this option is not specified, a branch resolved via the repository's HEAD
149 reference will be used.
151 Check out files from the specified
153 on the selected branch.
154 The expected argument is a commit ID SHA1 hash or an existing reference
155 or tag name which will be resolved to a commit ID.
156 An abbreviated hash argument will be expanded to a full SHA1 hash
157 automatically, provided the abbreviation is unique.
158 If this option is not specified, the most recent commit on the selected
160 .It Fl p Ar path-prefix
161 Restrict the work tree to a subset of the repository's tree hierarchy.
162 Only files beneath the specified
169 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
170 Update an existing work tree to a different commit.
171 Show the status of each affected file, using the following status codes:
172 .Bl -column YXZ description
173 .It U Ta file was updated and contained no local changes
174 .It G Ta file was updated and local changes were merged cleanly
175 .It C Ta file was updated and conflicts occurred during merge
176 .It D Ta file was deleted
177 .It A Ta new file was added
178 .It \(a~ Ta versioned file is obstructed by a non-regular file
179 .It ! Ta a missing versioned file was restored
184 is specified, update the entire work tree.
185 Otherwise, restrict the update operation to files at or within the
187 Each path is required to exist in the update operation's target commit.
188 Files in the work tree outside specified paths will remain unchanged and
189 will retain their previously recorded base commit.
192 commands may refuse to run while the work tree contains files from
193 multiple base commits.
194 The base commit of such a work tree can be made consistent by running
196 across the entire work tree.
199 is incompatible with the
204 cannot update paths with staged changes.
205 If changes have been staged with
207 these changes must first be committed with
217 Switch the work tree's branch reference to the specified
219 before updating the work tree.
220 This option requires that all paths in the work tree are updated.
222 Update the work tree to the specified
224 The expected argument is a commit ID SHA1 hash or an existing reference
225 or tag name which will be resolved to a commit ID.
226 An abbreviated hash argument will be expanded to a full SHA1 hash
227 automatically, provided the abbreviation is unique.
228 If this option is not specified, the most recent commit on the work tree's
234 .It Cm status Op Ar path ...
235 Show the current modification status of files in a work tree,
236 using the following status codes:
237 .Bl -column YXZ description
238 .It M Ta modified file
239 .It A Ta file scheduled for addition in next commit
240 .It D Ta file scheduled for deletion in next commit
241 .It C Ta modified or added file which contains merge conflicts
242 .It ! Ta versioned file was expected on disk but is missing
243 .It \(a~ Ta versioned file is obstructed by a non-regular file
244 .It ? Ta unversioned item not tracked by
246 .It N Ta non-existent
248 specified on the command line
253 is specified, show modifications in the entire work tree.
254 Otherwise, show modifications at or within the specified paths.
256 If changes have been staged with
258 staged changes are shown in the second output column, using the following
260 .Bl -column YXZ description
261 .It M Ta file modification is staged
262 .It A Ta file addition is staged
263 .It D Ta file deletion is staged
266 Changes created on top of staged changes are indicated in the first column:
267 .Bl -column YXZ description
268 .It MM Ta file was modified after earlier changes have been staged
269 .It MA Ta file was modified after having been staged for addition
272 For compatibility with
277 files in each traversed directory and will not display unversioned files
280 ignore patterns contained in
286 only supports a single ignore pattern per line.
290 .It Cm log Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl f Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl r Ar repository-path Oc Op Ar path
291 Display history of a repository.
294 is specified, show only commits which modified this path.
301 Start traversing history at the specified
303 The expected argument is a commit ID SHA1 hash or an existing reference
304 or tag name which will be resolved to a commit ID.
305 An abbreviated hash argument will be expanded to a full SHA1 hash
306 automatically, provided the abbreviation is unique.
307 If this option is not specified, default to the work tree's current branch
308 if invoked in a work tree, or to the repository's HEAD reference.
310 Set the number of context lines shown in diffs with
312 By default, 3 lines of context are shown.
314 Restrict history traversal to the first parent of each commit.
315 This shows the linear history of the current branch only.
316 Merge commits which affected the current branch will be shown but
317 individual commits which originated on other branches will be omitted.
319 Limit history traversal to a given number of commits.
320 If this option is not specified, a default limit value of zero is used,
321 which is treated as an unbounded limit.
323 .Ev GOT_LOG_DEFAULT_LIMIT
324 environment variable may be set to change this default value.
326 Display the patch of modifications made in each commit.
327 .It Fl r Ar repository-path
328 Use the repository at the specified path.
329 If not specified, assume the repository is located at or above the current
331 If this directory is a
333 work tree, use the repository path associated with this work tree.
335 .It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Op Ar object1 Ar object2 | Ar path
336 When invoked within a work tree with less than two arguments, display
337 uncommitted changes in the work tree.
340 is specified, only show changes within this path.
342 If two arguments are provided, treat each argument as a reference, a tag
343 name, or an object ID SHA1 hash, and display differences between the
344 corresponding objects.
345 Both objects must be of the same type (blobs, trees, or commits).
346 An abbreviated hash argument will be expanded to a full SHA1 hash
347 automatically, provided the abbreviation is unique.
354 Set the number of context lines shown in the diff.
355 By default, 3 lines of context are shown.
356 .It Fl r Ar repository-path
357 Use the repository at the specified path.
358 If not specified, assume the repository is located at or above the current
360 If this directory is a
362 work tree, use the repository path associated with this work tree.
364 Show changes staged with
366 instead of showing local changes.
367 This option is only valid when
369 is invoked in a work tree.
374 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
375 Display line-by-line history of a file at the specified path.
382 Start traversing history at the specified
384 The expected argument is a commit ID SHA1 hash or an existing reference
385 or tag name which will be resolved to a commit ID.
386 An abbreviated hash argument will be expanded to a full SHA1 hash
387 automatically, provided the abbreviation is unique.
388 .It Fl r Ar repository-path
389 Use the repository at the specified path.
390 If not specified, assume the repository is located at or above the current
392 If this directory is a
394 work tree, use the repository path associated with this work tree.
399 .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
400 Display a listing of files and directories at the specified
401 directory path in the repository.
402 Entries shown in this listing may carry one of the following trailing
404 .Bl -column YXZ description
405 .It @ Ta entry is a symbolic link
406 .It / Ta entry is a directory
407 .It * Ta entry is an executable file
408 .It $ Ta entry is a Git submodule
413 is specified, list the repository path corresponding to the current
414 directory of the work tree, or the root directory of the repository
415 if there is no work tree.
422 List files and directories as they appear in the specified
424 The expected argument is a commit ID SHA1 hash or an existing reference
425 or tag name which will be resolved to a commit ID.
426 An abbreviated hash argument will be expanded to a full SHA1 hash
427 automatically, provided the abbreviation is unique.
428 .It Fl r Ar repository-path
429 Use the repository at the specified path.
430 If not specified, assume the repository is located at or above the current
432 If this directory is a
434 work tree, use the repository path associated with this work tree.
436 Show object IDs of files (blob objects) and directories (tree objects).
438 Recurse into sub-directories in the repository.
443 .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
444 Manage references in a repository.
446 If no options are passed, expect two arguments and attempt to create,
447 or update, the reference with the given
449 and make it point at the given
451 The target may be an object ID SHA1 hash or an existing reference which
452 will be resolved to an object ID.
453 An abbreviated hash argument will be expanded to a full SHA1 hash
454 automatically, provided the abbreviation is unique.
460 .It Fl r Ar repository-path
461 Use the repository at the specified path.
462 If not specified, assume the repository is located at or above the current
464 If this directory is a
466 work tree, use the repository path associated with this work tree.
468 List all existing references in the repository.
470 Delete the reference with the specified name from the repository.
472 Create a symbolic reference pointing at the specified
474 which must be an existing reference.
475 Care should be taken not to create loops between references when
478 .It Cm branch Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Op Ar name Op Ar base-branch
479 Manage branches in a repository.
481 Branches are managed via references which live in the
486 command operates on references in this namespace only.
488 If no options are passed, expect one or two arguments and attempt to create
489 a branch with the given
491 and make it point at the given
495 is specified, default to the work tree's current branch if invoked in a
496 work tree, or to the repository's HEAD reference.
502 .It Fl r Ar repository-path
503 Use the repository at the specified path.
504 If not specified, assume the repository is located at or above the current
506 If this directory is a
508 work tree, use the repository path associated with this work tree.
510 List all existing branches in the repository.
511 If invoked in a work tree, the work tree's current branch is shown
512 with one the following annotations:
513 .Bl -column YXZ description
514 .It * Ta work tree's base commit matches the branch tip
515 .It \(a~ Ta work tree's base commit is out-of-date
518 Delete the branch with the specified name from the repository.
519 Only the branch reference is deleted.
520 Any commit, tree, and blob objects belonging to the branch
521 remain in the repository and may be removed separately with
522 Git's garbage collector.
527 .It Cm tag Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name Op Ar commit Oc
528 Manage tags in a repository.
530 Tags are managed via references which live in the
535 command operates on references in this namespace only.
536 References in this namespace point at tag objects which contain a pointer
537 to another object, a tag message, as well as author and timestamp information.
539 Expect one or two arguments and attempt to create a tag with the given
541 and make this tag point at the given
543 If no commit is specified, default to the latest commit on the work tree's
544 current branch if invoked in a work tree, and to a commit resolved via
545 the repository's HEAD reference otherwise.
546 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
547 reference or tag name which will be resolved to a commit ID.
548 An abbreviated hash argument will be expanded to a full SHA1 hash
549 automatically, provided the abbreviation is unique.
556 Use the specified tag message when creating the new tag
561 opens a temporary file in an editor where a tag message can be written.
562 .It Fl r Ar repository-path
563 Use the repository at the specified path.
564 If not specified, assume the repository is located at or above the current
566 If this directory is a
568 work tree, use the repository path associated with this work tree.
570 List all existing tags in the repository instead of creating a new tag.
571 If this option is used, no other command-line arguments are allowed.
576 command will not delete tags or change existing tags.
577 If a tag must be deleted, the
579 command may be used to delete a tag's reference.
580 This should only be done if the tag has not already been copied to
582 .It Cm add Ar file-path ...
583 Schedule unversioned files in a work tree for addition to the
584 repository in the next commit.
585 .It Cm remove Ar file-path ...
586 Remove versioned files from a work tree and schedule them for deletion
587 from the repository in the next commit.
594 Perform the operation even if a file contains uncommitted modifications.
599 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
600 Revert any uncommitted changes in files at the specified paths.
601 File contents will be overwritten with those contained in the
602 work tree's base commit.
603 There is no way to bring discarded changes back after
606 If a file was added with
608 it will become an unversioned file again.
609 If a file was deleted with
618 Instead of reverting all changes in files, interactively select or reject
619 changes to revert based on
625 (quit reverting this file) responses.
626 If a file is in modified status, individual patches derived from the
627 modified file content can be reverted.
628 Files in added or deleted status may only be reverted in their entirety.
629 .It Fl F Ar response-script
637 responses line-by-line from the specified
639 file instead of prompting interactively.
641 Permit recursion into directories.
642 If this option is not specified,
644 will refuse to run if a specified
651 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
652 Create a new commit in the repository from changes in a work tree
653 and use this commit as the new base commit for the work tree.
656 is specified, commit all changes in the work tree.
657 Otherwise, commit changes at or within the specified paths.
659 If changes have been explicitly staged for commit with
661 only commit staged changes and reject any specified paths which
662 have not been staged.
664 Show the status of each affected file, using the following status codes:
665 .Bl -column YXZ description
666 .It M Ta modified file
667 .It D Ta file was deleted
668 .It A Ta new file was added
671 Files which are not part of the new commit will retain their previously
672 recorded base commit.
675 commands may refuse to run while the work tree contains files from
676 multiple base commits.
677 The base commit of such a work tree can be made consistent by running
679 across the entire work tree.
685 environment variable to be set.
692 Use the specified log message when creating the new commit.
697 opens a temporary file in an editor where a log message can be written.
701 will refuse to run if certain preconditions are not met.
702 If the work tree's current branch is not in the
704 reference namespace, new commits may not be created on this branch.
705 Local changes may only be committed if they are based on file content
706 found in the most recent commit on the work tree's branch.
707 If a path is found to be out of date,
709 must be used first in order to merge local changes with changes made
714 .It Cm cherrypick Ar commit
715 Merge changes from a single
720 must be on a different branch than the work tree's base commit.
721 The expected argument is a reference or a commit ID SHA1 hash.
722 An abbreviated hash argument will be expanded to a full SHA1 hash
723 automatically, provided the abbreviation is unique.
725 Show the status of each affected file, using the following status codes:
726 .Bl -column YXZ description
727 .It G Ta file was merged
728 .It C Ta file was merged and conflicts occurred during merge
729 .It ! Ta changes destined for a missing file were not merged
730 .It D Ta file was deleted
731 .It d Ta file's deletion was obstructed by local modifications
732 .It A Ta new file was added
733 .It \(a~ Ta changes destined for a non-regular file were not merged
736 The merged changes will appear as local changes in the work tree, which
739 amended manually or with further
744 or discarded again with
748 will refuse to run if certain preconditions are not met.
749 If the work tree contains multiple base commits it must first be updated
750 to a single base commit with
752 If the work tree already contains files with merge conflicts, these
753 conflicts must be resolved first.
757 .It Cm backout Ar commit
758 Reverse-merge changes from a single
763 must be on the same branch as the work tree's base commit.
764 The expected argument is a reference or a commit ID SHA1 hash.
765 An abbreviated hash argument will be expanded to a full SHA1 hash
766 automatically, provided the abbreviation is unique.
768 Show the status of each affected file, using the following status codes:
769 .Bl -column YXZ description
770 .It G Ta file was merged
771 .It C Ta file was merged and conflicts occurred during merge
772 .It ! Ta changes destined for a missing file were not merged
773 .It D Ta file was deleted
774 .It d Ta file's deletion was obstructed by local modifications
775 .It A Ta new file was added
776 .It \(a~ Ta changes destined for a non-regular file were not merged
779 The reverse-merged changes will appear as local changes in the work tree,
780 which may be viewed with
782 amended manually or with further
787 or discarded again with
791 will refuse to run if certain preconditions are not met.
792 If the work tree contains multiple base commits it must first be updated
793 to a single base commit with
795 If the work tree already contains files with merge conflicts, these
796 conflicts must be resolved first.
800 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
801 Rebase commits on the specified
803 onto the tip of the current branch of the work tree.
806 must share common ancestry with the work tree's current branch.
807 Rebasing begins with the first descendant commit of the youngest
808 common ancestor commit shared by the specified
810 and the work tree's current branch, and stops once the tip commit
815 Rebased commits are accumulated on a temporary branch which the work tree
816 will remain switched to throughout the entire rebase operation.
817 Commits on this branch represent the same changes with the same log
818 messages as their counterparts on the original
820 but with different commit IDs.
821 Once rebasing has completed successfully, the temporary branch becomes
822 the new version of the specified
824 and the work tree is automatically switched to it.
826 While rebasing commits, show the status of each affected file,
827 using the following status codes:
828 .Bl -column YXZ description
829 .It G Ta file was merged
830 .It C Ta file was merged and conflicts occurred during merge
831 .It ! Ta changes destined for a missing file were not merged
832 .It D Ta file was deleted
833 .It d Ta file's deletion was obstructed by local modifications
834 .It A Ta new file was added
835 .It \(a~ Ta changes destined for a non-regular file were not merged
838 If merge conflicts occur the rebase operation is interrupted and may
839 be continued once conflicts have been resolved.
840 Alternatively, the rebase operation may be aborted which will leave
842 unmodified and the work tree switched back to its original branch.
844 If a merge conflict is resolved in a way which renders the merged
845 change into a no-op change, the corresponding commit will be elided
846 when the rebase operation continues.
849 will refuse to run if certain preconditions are not met.
850 If the work tree contains multiple base commits it must first be updated
851 to a single base commit with
853 If changes have been staged with
855 these changes must first be committed with
859 If the work tree contains local changes, these changes must first be
866 contains changes to files outside of the work tree's path prefix,
867 the work tree cannot be used to rebase this branch.
873 commands will refuse to run while a rebase operation is in progress.
874 Other commands which manipulate the work tree may be used for
875 conflict resolution purposes.
882 Abort an interrupted rebase operation.
883 If this option is used, no other command-line arguments are allowed.
885 Continue an interrupted rebase operation.
886 If this option is used, no other command-line arguments are allowed.
891 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
892 Edit commit history between the work tree's current base commit and
893 the tip commit of the work tree's current branch.
895 Editing of commit history is controlled via a
897 which can be edited interactively or passed on the command line.
898 The format of the histedit script is line-based.
899 Each line in the script begins with a command name, followed by
900 whitespace and an argument.
901 For most commands, the expected argument is a commit ID SHA1 hash.
902 Any remaining text on the line is ignored.
903 Lines which begin with the
905 character are ignored entirely.
907 The available commands are as follows:
908 .Bl -column YXZ pick-commit
909 .It pick Ar commit Ta Use the specified commit as it is.
910 .It edit Ar commit Ta Use the specified commit but once changes have been
911 merged into the work tree interrupt the histedit operation for amending.
912 .It fold Ar commit Ta Combine the specified commit with the next commit
913 listed further below that will be used.
914 .It drop Ar commit Ta Remove this commit from the edited history.
915 .It mesg Ar log-message Ta Use the specified single-line log message for
916 the commit on the previous line.
917 If the log message argument is left empty, open an editor where a new
918 log message can be written.
921 Every commit in the history being edited must be mentioned in the script.
922 Lines may be re-ordered to change the order of commits in the edited history.
924 Edited commits are accumulated on a temporary branch which the work tree
925 will remain switched to throughout the entire histedit operation.
926 Once history editing has completed successfully, the temporary branch becomes
927 the new version of the work tree's branch and the work tree is automatically
930 While merging commits, show the status of each affected file,
931 using the following status codes:
932 .Bl -column YXZ description
933 .It G Ta file was merged
934 .It C Ta file was merged and conflicts occurred during merge
935 .It ! Ta changes destined for a missing file were not merged
936 .It D Ta file was deleted
937 .It d Ta file's deletion was obstructed by local modifications
938 .It A Ta new file was added
939 .It \(a~ Ta changes destined for a non-regular file were not merged
942 If merge conflicts occur the histedit operation is interrupted and may
943 be continued once conflicts have been resolved.
944 Alternatively, the histedit operation may be aborted which will leave
945 the work tree switched back to its original branch.
947 If a merge conflict is resolved in a way which renders the merged
948 change into a no-op change, the corresponding commit will be elided
949 when the histedit operation continues.
952 will refuse to run if certain preconditions are not met.
953 If the work tree's current branch is not in the
955 reference namespace, the history of the branch may not be edited.
956 If the work tree contains multiple base commits it must first be updated
957 to a single base commit with
959 If changes have been staged with
961 these changes must first be committed with
965 If the work tree contains local changes, these changes must first be
970 If the edited history contains changes to files outside of the work tree's
971 path prefix, the work tree cannot be used to edit the history of this branch.
975 command will refuse to run while a histedit operation is in progress.
976 Other commands which manipulate the work tree may be used, and the
978 command may be used to commit arbitrary changes to the temporary branch
979 while the histedit operation is interrupted.
986 Abort an interrupted histedit operation.
987 If this option is used, no other command-line arguments are allowed.
989 Continue an interrupted histedit operation.
990 If this option is used, no other command-line arguments are allowed.
995 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
996 Stage local changes for inclusion in the next commit.
999 is specified, stage all changes in the work tree.
1000 Otherwise, stage changes at or within the specified paths.
1001 Paths may be staged if they are added, modified, or deleted according to
1004 Show the status of each affected file, using the following status codes:
1005 .Bl -column YXZ description
1006 .It A Ta file addition has been staged
1007 .It M Ta file modification has been staged
1008 .It D Ta file deletion has been staged
1011 Staged file contents are saved in newly created blob objects in the repository.
1012 These blobs will be referred to by tree objects once staged changes have been
1015 Staged changes affect the behaviour of
1020 While paths with staged changes exist, the
1022 command will refuse to commit any paths which do not have staged changes.
1023 Local changes created on top of staged changes can only be committed if
1024 the path is staged again, or if the staged changes are committed first.
1027 command will show both local changes and staged changes.
1030 command is able to display local changes relative to staged changes,
1031 and to display staged changes relative to the repository.
1034 command cannot revert staged changes but may be used to revert
1035 local changes created on top of staged changes.
1042 Instead of staging new changes, list paths which are already staged,
1043 along with the IDs of staged blob objects and stage status codes.
1044 If paths were provided in the command line show the staged paths
1045 among the specified paths.
1046 Otherwise, show all staged paths.
1048 Instead of staging the entire content of a changed file, interactively
1049 select or reject changes for staging based on
1053 (reject change), and
1055 (quit staging this file) responses.
1056 If a file is in modified status, individual patches derived from the
1057 modified file content can be staged.
1058 Files in added or deleted status may only be staged or rejected in
1060 .It Fl F Ar response-script
1068 responses line-by-line from the specified
1070 file instead of prompting interactively.
1074 will refuse to run if certain preconditions are not met.
1075 If a file contains merge conflicts, these conflicts must be resolved first.
1076 If a file is found to be out of date relative to the head commit on the
1077 work tree's current branch, the file must be updated with
1079 before it can be staged (however, this does not prevent the file from
1080 becoming out-of-date at some point after having been staged).
1087 commands will refuse to run while staged changes exist.
1088 If staged changes cannot be committed because a staged path
1089 is out of date, the path must be unstaged with
1091 before it can be updated with
1093 and may then be staged again if necessary.
1097 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1098 Merge staged changes back into the work tree and put affected paths
1099 back into non-staged status.
1102 is specified, unstage all staged changes across the entire work tree.
1103 Otherwise, unstage changes at or within the specified paths.
1105 Show the status of each affected file, using the following status codes:
1106 .Bl -column YXZ description
1107 .It G Ta file was unstaged
1108 .It C Ta file was unstaged and conflicts occurred during merge
1109 .It ! Ta changes destined for a missing file were not merged
1110 .It D Ta file was staged as deleted and still is deleted
1111 .It d Ta file's deletion was obstructed by local modifications
1112 .It \(a~ Ta changes destined for a non-regular file were not merged
1120 Instead of unstaging the entire content of a changed file, interactively
1121 select or reject changes for unstaging based on
1125 (keep change staged), and
1127 (quit unstaging this file) responses.
1128 If a file is staged in modified status, individual patches derived from the
1129 staged file content can be unstaged.
1130 Files staged in added or deleted status may only be unstaged in their entirety.
1131 .It Fl F Ar response-script
1139 responses line-by-line from the specified
1141 file instead of prompting interactively.
1146 .It Cm cat Oo Fl r Ar repository-path Oc Ar object ...
1147 Parse and print contents of specified objects to standard output
1148 in a line-based text format.
1149 Treat each argument as a reference, a tag name, or an object ID SHA1 hash.
1150 References will be resolved to an object ID.
1151 Tag names will resolved to a tag object.
1152 An abbreviated hash argument will be expanded to a full SHA1 hash
1153 automatically, provided the abbreviation is unique.
1159 .It Fl r Ar repository-path
1160 Use the repository at the specified path.
1161 If not specified, assume the repository is located at or above the current
1163 If this directory is a
1165 work tree, use the repository path associated with this work tree.
1169 .Bl -tag -width GOT_AUTHOR
1171 The author's name and email address for
1176 .An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1179 may fail to parse commits without an email address in author data,
1183 environment variables with a missing email address.
1184 .It Ev VISUAL , EDITOR
1185 The editor spawned by
1190 .It Ev GOT_LOG_DEFAULT_LIMIT
1191 The default limit on the number of commits traversed by
1193 If set to zero, the limit is unbounded.
1194 This variable will be silently ignored if it is set to a non-numeric value.
1199 Clone an existing Git repository for use with
1201 This step currently requires
1205 .Dl $ git clone --bare https://github.com/openbsd/src.git
1207 Alternatively, for quick and dirty local testing of
1209 a new Git repository could be created and populated with files,
1210 e.g. from a temporary CVS checkout located at
1213 .Dl $ got init /var/git/src.git
1214 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1216 Check out a work tree from the Git repository to /usr/src:
1218 .Dl $ got checkout /var/git/src.git /usr/src
1220 View local changes in a work tree directory:
1223 .Dl $ got diff | less
1225 Interactively revert selected local changes in a work tree directory:
1227 .Dl $ got revert -p -R\ .
1229 In a work tree or a git repository directory, list all branch references:
1233 In a work tree or a git repository directory, create a new branch called
1234 .Dq unified-buffer-cache
1235 which is forked off the
1239 .Dl $ got branch unified-buffer-cache master
1241 Switch an existing work tree to the branch
1242 .Dq unified-buffer-cache .
1243 Local changes in the work tree will be preserved and merged if necessary:
1245 .Dl $ got update -b unified-buffer-cache
1247 Create a new commit from local changes in a work tree directory.
1248 This new commit will become the head commit of the work tree's current branch:
1252 In a work tree or a git repository directory, view changes committed in
1253 the 3 most recent commits to the work tree's branch, or the branch resolved
1254 via the repository's HEAD reference, respectively:
1256 .Dl $ got log -p -l 3 -f
1258 Add new files and remove obsolete files in a work tree directory:
1260 .Dl $ got add sys/uvm/uvm_ubc.c
1261 .Dl $ got remove sys/uvm/uvm_vnode.c
1263 Create a new commit from local changes in a work tree directory
1264 with a pre-defined log message.
1266 .Dl $ got commit -m 'unify the buffer cache'
1268 Update any work tree checked out from the
1269 .Dq unified-buffer-cache
1270 branch to the latest commit on this branch:
1274 Roll file content on the unified-buffer-cache branch back by one commit,
1275 and then fetch the rolled-back change into the work tree as a local change
1276 to be amended and perhaps committed again:
1278 .Dl $ got backout unified-buffer-cache
1279 .Dl $ got commit -m 'roll back previous'
1280 .Dl $ # now back out the previous backout :-)
1281 .Dl $ got backout unified-buffer-cache
1283 Fetch new upstream commits into the local repository's master branch.
1284 This step currently requires
1287 .Dl $ cd /var/git/src.git
1288 .Dl $ git fetch origin master:master
1291 .Dq unified-buffer-cache
1292 branch on top of the new head commit of the
1296 .Dl $ got update -b master
1297 .Dl $ got rebase unified-buffer-cache
1299 Create a patch from all changes on the unified-buffer-cache branch.
1300 The patch can be mailed out for review and applied to
1304 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1306 Edit the entire commit history of the
1307 .Dq unified-buffer-cache
1310 .Dl $ got update -b unified-buffer-cache
1311 .Dl $ got update -c master
1314 Additional steps are necessary if local changes need to be pushed back
1315 to the remote repository, which currently requires
1319 Before working against existing branches in a repository cloned with
1320 .Dq git clone --bare ,
1323 must be configured to map all references in the remote repository
1326 namespace of the local repository.
1327 This can achieved by setting Git's
1328 .Pa remote.origin.fetch
1329 configuration variable to the value
1330 .Dq +refs/heads/*:refs/remotes/origin/*
1335 .Dl $ cd /var/git/repo
1336 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1338 Alternatively, the following
1340 configuration item can be added manually to the Git repository's
1344 .Dl [remote "origin"]
1346 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1348 This configuration leaves the local repository's
1350 namespace free for use by local branches checked out with
1352 and, if needed, created with
1357 namespace can be updated with incoming changes from the remote
1361 .Dl $ cd /var/git/repo
1364 Before outgoing changes on the local
1366 branch can be pushed to the remote repository, the local
1368 branch must be rebased onto the
1372 .Dl $ got update -b origin/master
1373 .Dl $ got rebase master
1375 Changes on the local
1377 branch can then be pushed to the remote
1381 .Dl $ cd /var/git/repo
1382 .Dl $ git push origin master
1385 .Xr git-repository 5 ,
1388 .An Stefan Sperling Aq Mt stsp@openbsd.org
1389 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1390 .An Joshua Stein Aq Mt jcs@openbsd.org
1393 is a work-in-progress and many commands remain to be implemented.
1394 At present, the user has to fall back on
1396 to perform many tasks, in particular tasks related to repository
1397 administration and tasks which require a network connection.
