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
250 is specified, show modifications in the entire work tree.
251 Otherwise, show modifications at or within the specified paths.
253 If changes have been staged with
255 staged changes are shown in the second output column, using the following
257 .Bl -column YXZ description
258 .It M Ta file modification is staged
259 .It A Ta file addition is staged
260 .It D Ta file deletion is staged
263 Changes created on top of staged changes are indicated in the first column:
264 .Bl -column YXZ description
265 .It MM Ta file was modified after earlier changes have been staged
266 .It MA Ta file was modified after having been staged for addition
269 For compatibility with
274 files in each traversed directory and will not display unversioned files
277 ignore patterns contained in
283 only supports a single ignore pattern per line.
287 .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
288 Display history of a repository.
291 is specified, show only commits which modified this path.
298 Start traversing history at the specified
300 The expected argument is a commit ID SHA1 hash or an existing reference
301 or tag name which will be resolved to a commit ID.
302 An abbreviated hash argument will be expanded to a full SHA1 hash
303 automatically, provided the abbreviation is unique.
304 If this option is not specified, default to the work tree's current branch
305 if invoked in a work tree, or to the repository's HEAD reference.
307 Set the number of context lines shown in diffs with
309 By default, 3 lines of context are shown.
311 Restrict history traversal to the first parent of each commit.
312 This shows the linear history of the current branch only.
313 Merge commits which affected the current branch will be shown but
314 individual commits which originated on other branches will be omitted.
316 Limit history traversal to a given number of commits.
317 If this option is not specified, a default limit value of zero is used,
318 which is treated as an unbounded limit.
320 .Ev GOT_LOG_DEFAULT_LIMIT
321 environment variable may be set to change this default value.
323 Display the patch of modifications made in each commit.
324 .It Fl r Ar repository-path
325 Use the repository at the specified path.
326 If not specified, assume the repository is located at or above the current
328 If this directory is a
330 work tree, use the repository path associated with this work tree.
332 .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
333 When invoked within a work tree with less than two arguments, display
334 uncommitted changes in the work tree.
337 is specified, only show changes within this path.
339 If two arguments are provided, treat each argument as a reference, a tag
340 name, or an object ID SHA1 hash, and display differences between the
341 corresponding objects.
342 Both objects must be of the same type (blobs, trees, or commits).
343 An abbreviated hash argument will be expanded to a full SHA1 hash
344 automatically, provided the abbreviation is unique.
351 Set the number of context lines shown in the diff.
352 By default, 3 lines of context are shown.
353 .It Fl r Ar repository-path
354 Use the repository at the specified path.
355 If not specified, assume the repository is located at or above the current
357 If this directory is a
359 work tree, use the repository path associated with this work tree.
361 Show changes staged with
363 instead of showing local changes.
364 This option is only valid when
366 is invoked in a work tree.
371 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
372 Display line-by-line history of a file at the specified path.
379 Start traversing history at the specified
381 The expected argument is a commit ID SHA1 hash or an existing reference
382 or tag name which will be resolved to a commit ID.
383 An abbreviated hash argument will be expanded to a full SHA1 hash
384 automatically, provided the abbreviation is unique.
385 .It Fl r Ar repository-path
386 Use the repository at the specified path.
387 If not specified, assume the repository is located at or above the current
389 If this directory is a
391 work tree, use the repository path associated with this work tree.
396 .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
397 Display a listing of files and directories at the specified
398 directory path in the repository.
399 Entries shown in this listing may carry one of the following trailing
401 .Bl -column YXZ description
402 .It @ Ta entry is a symbolic link
403 .It / Ta entry is a directory
404 .It * Ta entry is an executable file
409 is specified, list the repository path corresponding to the current
410 directory of the work tree, or the root directory of the repository
411 if there is no work tree.
418 List files and directories as they appear in the specified
420 The expected argument is a commit ID SHA1 hash or an existing reference
421 or tag name which will be resolved to a commit ID.
422 An abbreviated hash argument will be expanded to a full SHA1 hash
423 automatically, provided the abbreviation is unique.
424 .It Fl r Ar repository-path
425 Use the repository at the specified path.
426 If not specified, assume the repository is located at or above the current
428 If this directory is a
430 work tree, use the repository path associated with this work tree.
432 Show object IDs of files (blob objects) and directories (tree objects).
434 Recurse into sub-directories in the repository.
439 .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
440 Manage references in a repository.
442 If no options are passed, expect two arguments and attempt to create,
443 or update, the reference with the given
445 and make it point at the given
447 The target may be an object ID SHA1 hash or an existing reference which
448 will be resolved to an object ID.
449 An abbreviated hash argument will be expanded to a full SHA1 hash
450 automatically, provided the abbreviation is unique.
456 .It Fl r Ar repository-path
457 Use the repository at the specified path.
458 If not specified, assume the repository is located at or above the current
460 If this directory is a
462 work tree, use the repository path associated with this work tree.
464 List all existing references in the repository.
466 Delete the reference with the specified name from the repository.
468 Create a symbolic reference pointing at the specified
470 which must be an existing reference.
471 Care should be taken not to create loops between references when
474 .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
475 Manage branches in a repository.
477 Branches are managed via references which live in the
482 command operates on references in this namespace only.
484 If no options are passed, expect one or two arguments and attempt to create
485 a branch with the given
487 and make it point at the given
491 is specified, default to the work tree's current branch if invoked in a
492 work tree, or to the repository's HEAD reference.
498 .It Fl r Ar repository-path
499 Use the repository at the specified path.
500 If not specified, assume the repository is located at or above the current
502 If this directory is a
504 work tree, use the repository path associated with this work tree.
506 List all existing branches in the repository.
507 If invoked in a work tree, the work tree's current branch is shown
508 with one the following annotations:
509 .Bl -column YXZ description
510 .It * Ta work tree's base commit matches the branch tip
511 .It \(a~ Ta work tree's base commit is out-of-date
514 Delete the branch with the specified name from the repository.
515 Only the branch reference is deleted.
516 Any commit, tree, and blob objects belonging to the branch
517 remain in the repository and may be removed separately with
518 Git's garbage collector.
523 .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
524 Manage tags in a repository.
526 Tags are managed via references which live in the
531 command operates on references in this namespace only.
532 References in this namespace point at tag objects which contain a pointer
533 to another object, a tag message, as well as author and timestamp information.
535 Expect one or two arguments and attempt to create a tag with the given
537 and make this tag point at the given
539 If no commit is specified, default to the latest commit on the work tree's
540 current branch if invoked in a work tree, and to a commit resolved via
541 the repository's HEAD reference otherwise.
542 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
543 reference or tag name which will be resolved to a commit ID.
544 An abbreviated hash argument will be expanded to a full SHA1 hash
545 automatically, provided the abbreviation is unique.
552 Use the specified tag message when creating the new tag
557 opens a temporary file in an editor where a tag message can be written.
558 .It Fl r Ar repository-path
559 Use the repository at the specified path.
560 If not specified, assume the repository is located at or above the current
562 If this directory is a
564 work tree, use the repository path associated with this work tree.
566 List all existing tags in the repository instead of creating a new tag.
567 If this option is used, no other command-line arguments are allowed.
572 command will not delete tags or change existing tags.
573 If a tag must be deleted, the
575 command may be used to delete a tag's reference.
576 This should only be done if the tag has not already been copied to
578 .It Cm add Ar file-path ...
579 Schedule unversioned files in a work tree for addition to the
580 repository in the next commit.
581 .It Cm remove Ar file-path ...
582 Remove versioned files from a work tree and schedule them for deletion
583 from the repository in the next commit.
590 Perform the operation even if a file contains uncommitted modifications.
595 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
596 Revert any uncommitted changes in files at the specified paths.
597 File contents will be overwritten with those contained in the
598 work tree's base commit.
599 There is no way to bring discarded changes back after
602 If a file was added with
604 it will become an unversioned file again.
605 If a file was deleted with
614 Instead of reverting all changes in files, interactively select or reject
615 changes to revert based on
621 (quit reverting this file) responses.
622 If a file is in modified status, individual patches derived from the
623 modified file content can be reverted.
624 Files in added or deleted status may only be reverted in their entirety.
625 .It Fl F Ar response-script
633 responses line-by-line from the specified
635 file instead of prompting interactively.
637 Permit recursion into directories.
638 If this option is not specified,
640 will refuse to run if a specified
647 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
648 Create a new commit in the repository from changes in a work tree
649 and use this commit as the new base commit for the work tree.
652 is specified, commit all changes in the work tree.
653 Otherwise, commit changes at or within the specified paths.
655 If changes have been explicitly staged for commit with
657 only commit staged changes and reject any specified paths which
658 have not been staged.
660 Show the status of each affected file, using the following status codes:
661 .Bl -column YXZ description
662 .It M Ta modified file
663 .It D Ta file was deleted
664 .It A Ta new file was added
667 Files which are not part of the new commit will retain their previously
668 recorded base commit.
671 commands may refuse to run while the work tree contains files from
672 multiple base commits.
673 The base commit of such a work tree can be made consistent by running
675 across the entire work tree.
681 environment variable to be set.
688 Use the specified log message when creating the new commit.
693 opens a temporary file in an editor where a log message can be written.
697 will refuse to run if certain preconditions are not met.
698 If the work tree's current branch is not in the
700 reference namespace, new commits may not be created on this branch.
701 Local changes may only be committed if they are based on file content
702 found in the most recent commit on the work tree's branch.
703 If a path is found to be out of date,
705 must be used first in order to merge local changes with changes made
710 .It Cm cherrypick Ar commit
711 Merge changes from a single
716 must be on a different branch than the work tree's base commit.
717 The expected argument is a reference or a commit ID SHA1 hash.
718 An abbreviated hash argument will be expanded to a full SHA1 hash
719 automatically, provided the abbreviation is unique.
721 Show the status of each affected file, using the following status codes:
722 .Bl -column YXZ description
723 .It G Ta file was merged
724 .It C Ta file was merged and conflicts occurred during merge
725 .It ! Ta changes destined for a missing file were not merged
726 .It D Ta file was deleted
727 .It d Ta file's deletion was obstructed by local modifications
728 .It A Ta new file was added
729 .It \(a~ Ta changes destined for a non-regular file were not merged
732 The merged changes will appear as local changes in the work tree, which
735 amended manually or with further
740 or discarded again with
744 will refuse to run if certain preconditions are not met.
745 If the work tree contains multiple base commits it must first be updated
746 to a single base commit with
748 If the work tree already contains files with merge conflicts, these
749 conflicts must be resolved first.
753 .It Cm backout Ar commit
754 Reverse-merge changes from a single
759 must be on the same branch as the work tree's base commit.
760 The expected argument is a reference or a commit ID SHA1 hash.
761 An abbreviated hash argument will be expanded to a full SHA1 hash
762 automatically, provided the abbreviation is unique.
764 Show the status of each affected file, using the following status codes:
765 .Bl -column YXZ description
766 .It G Ta file was merged
767 .It C Ta file was merged and conflicts occurred during merge
768 .It ! Ta changes destined for a missing file were not merged
769 .It D Ta file was deleted
770 .It d Ta file's deletion was obstructed by local modifications
771 .It A Ta new file was added
772 .It \(a~ Ta changes destined for a non-regular file were not merged
775 The reverse-merged changes will appear as local changes in the work tree,
776 which may be viewed with
778 amended manually or with further
783 or discarded again with
787 will refuse to run if certain preconditions are not met.
788 If the work tree contains multiple base commits it must first be updated
789 to a single base commit with
791 If the work tree already contains files with merge conflicts, these
792 conflicts must be resolved first.
796 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
797 Rebase commits on the specified
799 onto the tip of the current branch of the work tree.
802 must share common ancestry with the work tree's current branch.
803 Rebasing begins with the first descendant commit of the youngest
804 common ancestor commit shared by the specified
806 and the work tree's current branch, and stops once the tip commit
811 Rebased commits are accumulated on a temporary branch which the work tree
812 will remain switched to throughout the entire rebase operation.
813 Commits on this branch represent the same changes with the same log
814 messages as their counterparts on the original
816 but with different commit IDs.
817 Once rebasing has completed successfully, the temporary branch becomes
818 the new version of the specified
820 and the work tree is automatically switched to it.
822 While rebasing commits, show the status of each affected file,
823 using the following status codes:
824 .Bl -column YXZ description
825 .It G Ta file was merged
826 .It C Ta file was merged and conflicts occurred during merge
827 .It ! Ta changes destined for a missing file were not merged
828 .It D Ta file was deleted
829 .It d Ta file's deletion was obstructed by local modifications
830 .It A Ta new file was added
831 .It \(a~ Ta changes destined for a non-regular file were not merged
834 If merge conflicts occur the rebase operation is interrupted and may
835 be continued once conflicts have been resolved.
836 Alternatively, the rebase operation may be aborted which will leave
838 unmodified and the work tree switched back to its original branch.
840 If a merge conflict is resolved in a way which renders the merged
841 change into a no-op change, the corresponding commit will be elided
842 when the rebase operation continues.
845 will refuse to run if certain preconditions are not met.
846 If the work tree contains multiple base commits it must first be updated
847 to a single base commit with
849 If changes have been staged with
851 these changes must first be committed with
855 If the work tree contains local changes, these changes must first be
862 contains changes to files outside of the work tree's path prefix,
863 the work tree cannot be used to rebase this branch.
869 commands will refuse to run while a rebase operation is in progress.
870 Other commands which manipulate the work tree may be used for
871 conflict resolution purposes.
878 Abort an interrupted rebase operation.
879 If this option is used, no other command-line arguments are allowed.
881 Continue an interrupted rebase operation.
882 If this option is used, no other command-line arguments are allowed.
887 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
888 Edit commit history between the work tree's current base commit and
889 the tip commit of the work tree's current branch.
891 Editing of commit history is controlled via a
893 which can be edited interactively or passed on the command line.
894 The format of the histedit script is line-based.
895 Each line in the script begins with a command name, followed by
896 whitespace and an argument.
897 For most commands, the expected argument is a commit ID SHA1 hash.
898 Any remaining text on the line is ignored.
899 Lines which begin with the
901 character are ignored entirely.
903 The available commands are as follows:
904 .Bl -column YXZ pick-commit
905 .It pick Ar commit Ta Use the specified commit as it is.
906 .It edit Ar commit Ta Use the specified commit but once changes have been
907 merged into the work tree interrupt the histedit operation for amending.
908 .It fold Ar commit Ta Combine the specified commit with the next commit
909 listed further below that will be used.
910 .It drop Ar commit Ta Remove this commit from the edited history.
911 .It mesg Ar log-message Ta Use the specified single-line log message for
912 the commit on the previous line.
913 If the log message argument is left empty, open an editor where a new
914 log message can be written.
917 Every commit in the history being edited must be mentioned in the script.
918 Lines may be re-ordered to change the order of commits in the edited history.
920 Edited commits are accumulated on a temporary branch which the work tree
921 will remain switched to throughout the entire histedit operation.
922 Once history editing has completed successfully, the temporary branch becomes
923 the new version of the work tree's branch and the work tree is automatically
926 While merging 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 histedit operation is interrupted and may
939 be continued once conflicts have been resolved.
940 Alternatively, the histedit operation may be aborted which will leave
941 the work tree switched back to its original branch.
943 If a merge conflict is resolved in a way which renders the merged
944 change into a no-op change, the corresponding commit will be elided
945 when the histedit operation continues.
948 will refuse to run if certain preconditions are not met.
949 If the work tree's current branch is not in the
951 reference namespace, the history of the branch may not be edited.
952 If the work tree contains multiple base commits it must first be updated
953 to a single base commit with
955 If changes have been staged with
957 these changes must first be committed with
961 If the work tree contains local changes, these changes must first be
966 If the edited history contains changes to files outside of the work tree's
967 path prefix, the work tree cannot be used to edit the history of this branch.
971 command will refuse to run while a histedit operation is in progress.
972 Other commands which manipulate the work tree may be used, and the
974 command may be used to commit arbitrary changes to the temporary branch
975 while the histedit operation is interrupted.
982 Abort an interrupted histedit operation.
983 If this option is used, no other command-line arguments are allowed.
985 Continue an interrupted histedit operation.
986 If this option is used, no other command-line arguments are allowed.
991 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
992 Stage local changes for inclusion in the next commit.
995 is specified, stage all changes in the work tree.
996 Otherwise, stage changes at or within the specified paths.
997 Paths may be staged if they are added, modified, or deleted according to
1000 Show the status of each affected file, using the following status codes:
1001 .Bl -column YXZ description
1002 .It A Ta file addition has been staged
1003 .It M Ta file modification has been staged
1004 .It D Ta file deletion has been staged
1007 Staged file contents are saved in newly created blob objects in the repository.
1008 These blobs will be referred to by tree objects once staged changes have been
1011 Staged changes affect the behaviour of
1016 While paths with staged changes exist, the
1018 command will refuse to commit any paths which do not have staged changes.
1019 Local changes created on top of staged changes can only be committed if
1020 the path is staged again, or if the staged changes are committed first.
1023 command will show both local changes and staged changes.
1026 command is able to display local changes relative to staged changes,
1027 and to display staged changes relative to the repository.
1030 command cannot revert staged changes but may be used to revert
1031 local changes created on top of staged changes.
1038 Instead of staging new changes, list paths which are already staged,
1039 along with the IDs of staged blob objects and stage status codes.
1040 If paths were provided in the command line show the staged paths
1041 among the specified paths.
1042 Otherwise, show all staged paths.
1044 Instead of staging the entire content of a changed file, interactively
1045 select or reject changes for staging based on
1049 (reject change), and
1051 (quit staging this file) responses.
1052 If a file is in modified status, individual patches derived from the
1053 modified file content can be staged.
1054 Files in added or deleted status may only be staged or rejected in
1056 .It Fl F Ar response-script
1064 responses line-by-line from the specified
1066 file instead of prompting interactively.
1070 will refuse to run if certain preconditions are not met.
1071 If a file contains merge conflicts, these conflicts must be resolved first.
1072 If a file is found to be out of date relative to the head commit on the
1073 work tree's current branch, the file must be updated with
1075 before it can be staged (however, this does not prevent the file from
1076 becoming out-of-date at some point after having been staged).
1083 commands will refuse to run while staged changes exist.
1084 If staged changes cannot be committed because a staged path
1085 is out of date, the path must be unstaged with
1087 before it can be updated with
1089 and may then be staged again if necessary.
1093 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1094 Merge staged changes back into the work tree and put affected paths
1095 back into non-staged status.
1098 is specified, unstage all staged changes across the entire work tree.
1099 Otherwise, unstage changes at or within the specified paths.
1101 Show the status of each affected file, using the following status codes:
1102 .Bl -column YXZ description
1103 .It G Ta file was unstaged
1104 .It C Ta file was unstaged and conflicts occurred during merge
1105 .It ! Ta changes destined for a missing file were not merged
1106 .It D Ta file was staged as deleted and still is deleted
1107 .It d Ta file's deletion was obstructed by local modifications
1108 .It \(a~ Ta changes destined for a non-regular file were not merged
1116 Instead of unstaging the entire content of a changed file, interactively
1117 select or reject changes for unstaging based on
1121 (keep change staged), and
1123 (quit unstaging this file) responses.
1124 If a file is staged in modified status, individual patches derived from the
1125 staged file content can be unstaged.
1126 Files staged in added or deleted status may only be unstaged in their entirety.
1127 .It Fl F Ar response-script
1135 responses line-by-line from the specified
1137 file instead of prompting interactively.
1142 .It Cm cat Oo Fl r Ar repository-path Oc Ar object ...
1143 Parse and print contents of specified objects to standard output
1144 in a line-based text format.
1145 Treat each argument as a reference, a tag name, or an object ID SHA1 hash.
1146 References will be resolved to an object ID.
1147 Tag names will resolved to a tag object.
1148 An abbreviated hash argument will be expanded to a full SHA1 hash
1149 automatically, provided the abbreviation is unique.
1155 .It Fl r Ar repository-path
1156 Use the repository at the specified path.
1157 If not specified, assume the repository is located at or above the current
1159 If this directory is a
1161 work tree, use the repository path associated with this work tree.
1165 .Bl -tag -width GOT_AUTHOR
1167 The author's name and email address for
1172 .An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1175 may fail to parse commits without an email address in author data,
1179 environment variables with a missing email address.
1180 .It Ev VISUAL , EDITOR
1181 The editor spawned by
1186 .It Ev GOT_LOG_DEFAULT_LIMIT
1187 The default limit on the number of commits traversed by
1189 If set to zero, the limit is unbounded.
1190 This variable will be silently ignored if it is set to a non-numeric value.
1195 Clone an existing Git repository for use with
1197 This step currently requires
1201 .Dl $ git clone --bare https://github.com/openbsd/src.git
1203 Alternatively, for quick and dirty local testing of
1205 a new Git repository could be created and populated with files,
1206 e.g. from a temporary CVS checkout located at
1209 .Dl $ got init /var/git/src.git
1210 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1212 Check out a work tree from the Git repository to /usr/src:
1214 .Dl $ got checkout /var/git/src.git /usr/src
1216 View local changes in a work tree directory:
1219 .Dl $ got diff | less
1221 Interactively revert selected local changes in a work tree directory:
1223 .Dl $ got revert -p -R\ .
1225 In a work tree or a git repository directory, list all branch references:
1229 In a work tree or a git repository directory, create a new branch called
1230 .Dq unified-buffer-cache
1231 which is forked off the
1235 .Dl $ got branch unified-buffer-cache master
1237 Switch an existing work tree to the branch
1238 .Dq unified-buffer-cache .
1239 Local changes in the work tree will be preserved and merged if necessary:
1241 .Dl $ got update -b unified-buffer-cache
1243 Create a new commit from local changes in a work tree directory.
1244 This new commit will become the head commit of the work tree's current branch:
1248 In a work tree or a git repository directory, view changes committed in
1249 the 3 most recent commits to the work tree's branch, or the branch resolved
1250 via the repository's HEAD reference, respectively:
1252 .Dl $ got log -p -l 3 -f
1254 Add new files and remove obsolete files in a work tree directory:
1256 .Dl $ got add sys/uvm/uvm_ubc.c
1257 .Dl $ got remove sys/uvm/uvm_vnode.c
1259 Create a new commit from local changes in a work tree directory
1260 with a pre-defined log message.
1262 .Dl $ got commit -m 'unify the buffer cache'
1264 Update any work tree checked out from the
1265 .Dq unified-buffer-cache
1266 branch to the latest commit on this branch:
1270 Roll file content on the unified-buffer-cache branch back by one commit,
1271 and then fetch the rolled-back change into the work tree as a local change
1272 to be amended and perhaps committed again:
1274 .Dl $ got backout unified-buffer-cache
1275 .Dl $ got commit -m 'roll back previous'
1276 .Dl $ # now back out the previous backout :-)
1277 .Dl $ got backout unified-buffer-cache
1279 Fetch new upstream commits into the local repository's master branch.
1280 This step currently requires
1283 .Dl $ cd /var/git/src.git
1284 .Dl $ git fetch origin master:master
1287 .Dq unified-buffer-cache
1288 branch on top of the new head commit of the
1292 .Dl $ got update -b master
1293 .Dl $ got rebase unified-buffer-cache
1295 Create a patch from all changes on the unified-buffer-cache branch.
1296 The patch can be mailed out for review and applied to
1300 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1302 Edit the entire commit history of the
1303 .Dq unified-buffer-cache
1306 .Dl $ got update -b unified-buffer-cache
1307 .Dl $ got update -c master
1310 Additional steps are necessary if local changes need to be pushed back
1311 to the remote repository, which currently requires
1315 Before working against existing branches in a repository cloned with
1316 .Dq git clone --bare ,
1319 must be configured to map all references in the remote repository
1322 namespace of the local repository.
1323 This can achieved by setting Git's
1324 .Pa remote.origin.fetch
1325 configuration variable to the value
1326 .Dq +refs/heads/*:refs/remotes/origin/*
1331 .Dl $ cd /var/git/repo
1332 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1334 Alternatively, the following
1336 configuration item can be added manually to the Git repository's
1340 .Dl [remote "origin"]
1342 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1344 This configuration leaves the local repository's
1346 namespace free for use by local branches checked out with
1348 and, if needed, created with
1353 namespace can be updated with incoming changes from the remote
1357 .Dl $ cd /var/git/repo
1360 Before outgoing changes on the local
1362 branch can be pushed to the remote repository, the local
1364 branch must be rebased onto the
1368 .Dl $ got update -b origin/master
1369 .Dl $ got rebase master
1371 Changes on the local
1373 branch can then be pushed to the remote
1377 .Dl $ cd /var/git/repo
1378 .Dl $ git push origin master
1381 .Xr git-repository 5 ,
1384 .An Stefan Sperling Aq Mt stsp@openbsd.org
1385 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1386 .An Joshua Stein Aq Mt jcs@openbsd.org
1389 is a work-in-progress and many commands remain to be implemented.
1390 At present, the user has to fall back on
1392 to perform many tasks, in particular tasks related to repository
1393 administration and tasks which require a network connection.
