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.
329 is specified, only show the patch of modifications at or within this path.
330 .It Fl r Ar repository-path
331 Use the repository at the specified path.
332 If not specified, assume the repository is located at or above the current
334 If this directory is a
336 work tree, use the repository path associated with this work tree.
338 .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
339 When invoked within a work tree with less than two arguments, display
340 uncommitted changes in the work tree.
343 is specified, only show changes within this path.
345 If two arguments are provided, treat each argument as a reference, a tag
346 name, or an object ID SHA1 hash, and display differences between the
347 corresponding objects.
348 Both objects must be of the same type (blobs, trees, or commits).
349 An abbreviated hash argument will be expanded to a full SHA1 hash
350 automatically, provided the abbreviation is unique.
357 Set the number of context lines shown in the diff.
358 By default, 3 lines of context are shown.
359 .It Fl r Ar repository-path
360 Use the repository at the specified path.
361 If not specified, assume the repository is located at or above the current
363 If this directory is a
365 work tree, use the repository path associated with this work tree.
367 Show changes staged with
369 instead of showing local changes.
370 This option is only valid when
372 is invoked in a work tree.
377 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
378 Display line-by-line history of a file at the specified path.
385 Start traversing history at the specified
387 The expected argument is a commit ID SHA1 hash or an existing reference
388 or tag name which will be resolved to a commit ID.
389 An abbreviated hash argument will be expanded to a full SHA1 hash
390 automatically, provided the abbreviation is unique.
391 .It Fl r Ar repository-path
392 Use the repository at the specified path.
393 If not specified, assume the repository is located at or above the current
395 If this directory is a
397 work tree, use the repository path associated with this work tree.
402 .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
403 Display a listing of files and directories at the specified
404 directory path in the repository.
405 Entries shown in this listing may carry one of the following trailing
407 .Bl -column YXZ description
408 .It @ Ta entry is a symbolic link
409 .It / Ta entry is a directory
410 .It * Ta entry is an executable file
411 .It $ Ta entry is a Git submodule
416 is specified, list the repository path corresponding to the current
417 directory of the work tree, or the root directory of the repository
418 if there is no work tree.
425 List files and directories as they appear in the specified
427 The expected argument is a commit ID SHA1 hash or an existing reference
428 or tag name which will be resolved to a commit ID.
429 An abbreviated hash argument will be expanded to a full SHA1 hash
430 automatically, provided the abbreviation is unique.
431 .It Fl r Ar repository-path
432 Use the repository at the specified path.
433 If not specified, assume the repository is located at or above the current
435 If this directory is a
437 work tree, use the repository path associated with this work tree.
439 Show object IDs of files (blob objects) and directories (tree objects).
441 Recurse into sub-directories in the repository.
446 .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
447 Manage references in a repository.
449 If no options are passed, expect two arguments and attempt to create,
450 or update, the reference with the given
452 and make it point at the given
454 The target may be an object ID SHA1 hash or an existing reference which
455 will be resolved to an object ID.
456 An abbreviated hash argument will be expanded to a full SHA1 hash
457 automatically, provided the abbreviation is unique.
463 .It Fl r Ar repository-path
464 Use the repository at the specified path.
465 If not specified, assume the repository is located at or above the current
467 If this directory is a
469 work tree, use the repository path associated with this work tree.
471 List all existing references in the repository.
473 Delete the reference with the specified name from the repository.
475 Create a symbolic reference pointing at the specified
477 which must be an existing reference.
478 Care should be taken not to create loops between references when
481 .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 commit
482 Manage branches in a repository.
484 Branches are managed via references which live in the
489 command operates on references in this namespace only.
491 If no options are passed, expect one or two arguments and attempt to create
492 a branch reference with the given
494 and make it point at the given
498 argument is a commit ID SHA1 hash or an existing reference
499 or tag name which will be resolved to a commit ID.
502 is specified, default to the latest commit on the work tree's current
503 branch if invoked in a work tree, or to a commit resolved via the
504 repository's HEAD reference.
510 .It Fl r Ar repository-path
511 Use the repository at the specified path.
512 If not specified, assume the repository is located at or above the current
514 If this directory is a
516 work tree, use the repository path associated with this work tree.
518 List all existing branches in the repository.
519 If invoked in a work tree, the work tree's current branch is shown
520 with one the following annotations:
521 .Bl -column YXZ description
522 .It * Ta work tree's base commit matches the branch tip
523 .It \(a~ Ta work tree's base commit is out-of-date
526 Delete the branch with the specified name from the repository.
527 Only the branch reference is deleted.
528 Any commit, tree, and blob objects belonging to the branch
529 remain in the repository and may be removed separately with
530 Git's garbage collector.
535 .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
536 Manage tags in a repository.
538 Tags are managed via references which live in the
543 command operates on references in this namespace only.
544 References in this namespace point at tag objects which contain a pointer
545 to another object, a tag message, as well as author and timestamp information.
547 Expect one or two arguments and attempt to create a tag with the given
549 and make this tag point at the given
551 If no commit is specified, default to the latest commit on the work tree's
552 current branch if invoked in a work tree, and to a commit resolved via
553 the repository's HEAD reference otherwise.
554 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
555 reference or tag name which will be resolved to a commit ID.
556 An abbreviated hash argument will be expanded to a full SHA1 hash
557 automatically, provided the abbreviation is unique.
564 Use the specified tag message when creating the new tag
569 opens a temporary file in an editor where a tag message can be written.
570 .It Fl r Ar repository-path
571 Use the repository at the specified path.
572 If not specified, assume the repository is located at or above the current
574 If this directory is a
576 work tree, use the repository path associated with this work tree.
578 List all existing tags in the repository instead of creating a new tag.
579 If this option is used, no other command-line arguments are allowed.
584 command will not delete tags or change existing tags.
585 If a tag must be deleted, the
587 command may be used to delete a tag's reference.
588 This should only be done if the tag has not already been copied to
590 .It Cm add Ar file-path ...
591 Schedule unversioned files in a work tree for addition to the
592 repository in the next commit.
593 .It Cm remove Ar file-path ...
594 Remove versioned files from a work tree and schedule them for deletion
595 from the repository in the next commit.
602 Perform the operation even if a file contains uncommitted modifications.
607 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
608 Revert any uncommitted changes in files at the specified paths.
609 File contents will be overwritten with those contained in the
610 work tree's base commit.
611 There is no way to bring discarded changes back after
614 If a file was added with
616 it will become an unversioned file again.
617 If a file was deleted with
626 Instead of reverting all changes in files, interactively select or reject
627 changes to revert based on
633 (quit reverting this file) responses.
634 If a file is in modified status, individual patches derived from the
635 modified file content can be reverted.
636 Files in added or deleted status may only be reverted in their entirety.
637 .It Fl F Ar response-script
645 responses line-by-line from the specified
647 file instead of prompting interactively.
649 Permit recursion into directories.
650 If this option is not specified,
652 will refuse to run if a specified
659 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
660 Create a new commit in the repository from changes in a work tree
661 and use this commit as the new base commit for the work tree.
664 is specified, commit all changes in the work tree.
665 Otherwise, commit changes at or within the specified paths.
667 If changes have been explicitly staged for commit with
669 only commit staged changes and reject any specified paths which
670 have not been staged.
672 Show the status of each affected file, using the following status codes:
673 .Bl -column YXZ description
674 .It M Ta modified file
675 .It D Ta file was deleted
676 .It A Ta new file was added
679 Files which are not part of the new commit will retain their previously
680 recorded base commit.
683 commands may refuse to run while the work tree contains files from
684 multiple base commits.
685 The base commit of such a work tree can be made consistent by running
687 across the entire work tree.
693 environment variable to be set.
700 Use the specified log message when creating the new commit.
705 opens a temporary file in an editor where a log message can be written.
709 will refuse to run if certain preconditions are not met.
710 If the work tree's current branch is not in the
712 reference namespace, new commits may not be created on this branch.
713 Local changes may only be committed if they are based on file content
714 found in the most recent commit on the work tree's branch.
715 If a path is found to be out of date,
717 must be used first in order to merge local changes with changes made
722 .It Cm cherrypick Ar commit
723 Merge changes from a single
728 must be on a different branch than the work tree's base commit.
729 The expected argument is a reference or a commit ID SHA1 hash.
730 An abbreviated hash argument will be expanded to a full SHA1 hash
731 automatically, provided the abbreviation is unique.
733 Show the status of each affected file, using the following status codes:
734 .Bl -column YXZ description
735 .It G Ta file was merged
736 .It C Ta file was merged and conflicts occurred during merge
737 .It ! Ta changes destined for a missing file were not merged
738 .It D Ta file was deleted
739 .It d Ta file's deletion was obstructed by local modifications
740 .It A Ta new file was added
741 .It \(a~ Ta changes destined for a non-regular file were not merged
744 The merged changes will appear as local changes in the work tree, which
747 amended manually or with further
752 or discarded again with
756 will refuse to run if certain preconditions are not met.
757 If the work tree contains multiple base commits it must first be updated
758 to a single base commit with
760 If the work tree already contains files with merge conflicts, these
761 conflicts must be resolved first.
765 .It Cm backout Ar commit
766 Reverse-merge changes from a single
771 must be on the same branch as the work tree's base commit.
772 The expected argument is a reference or a commit ID SHA1 hash.
773 An abbreviated hash argument will be expanded to a full SHA1 hash
774 automatically, provided the abbreviation is unique.
776 Show the status of each affected file, using the following status codes:
777 .Bl -column YXZ description
778 .It G Ta file was merged
779 .It C Ta file was merged and conflicts occurred during merge
780 .It ! Ta changes destined for a missing file were not merged
781 .It D Ta file was deleted
782 .It d Ta file's deletion was obstructed by local modifications
783 .It A Ta new file was added
784 .It \(a~ Ta changes destined for a non-regular file were not merged
787 The reverse-merged changes will appear as local changes in the work tree,
788 which may be viewed with
790 amended manually or with further
795 or discarded again with
799 will refuse to run if certain preconditions are not met.
800 If the work tree contains multiple base commits it must first be updated
801 to a single base commit with
803 If the work tree already contains files with merge conflicts, these
804 conflicts must be resolved first.
808 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
809 Rebase commits on the specified
811 onto the tip of the current branch of the work tree.
814 must share common ancestry with the work tree's current branch.
815 Rebasing begins with the first descendant commit of the youngest
816 common ancestor commit shared by the specified
818 and the work tree's current branch, and stops once the tip commit
823 Rebased commits are accumulated on a temporary branch which the work tree
824 will remain switched to throughout the entire rebase operation.
825 Commits on this branch represent the same changes with the same log
826 messages as their counterparts on the original
828 but with different commit IDs.
829 Once rebasing has completed successfully, the temporary branch becomes
830 the new version of the specified
832 and the work tree is automatically switched to it.
834 While rebasing commits, show the status of each affected file,
835 using the following status codes:
836 .Bl -column YXZ description
837 .It G Ta file was merged
838 .It C Ta file was merged and conflicts occurred during merge
839 .It ! Ta changes destined for a missing file were not merged
840 .It D Ta file was deleted
841 .It d Ta file's deletion was obstructed by local modifications
842 .It A Ta new file was added
843 .It \(a~ Ta changes destined for a non-regular file were not merged
846 If merge conflicts occur the rebase operation is interrupted and may
847 be continued once conflicts have been resolved.
848 Alternatively, the rebase operation may be aborted which will leave
850 unmodified and the work tree switched back to its original branch.
852 If a merge conflict is resolved in a way which renders the merged
853 change into a no-op change, the corresponding commit will be elided
854 when the rebase operation continues.
857 will refuse to run if certain preconditions are not met.
858 If the work tree contains multiple base commits it must first be updated
859 to a single base commit with
861 If changes have been staged with
863 these changes must first be committed with
867 If the work tree contains local changes, these changes must first be
874 contains changes to files outside of the work tree's path prefix,
875 the work tree cannot be used to rebase this branch.
881 commands will refuse to run while a rebase operation is in progress.
882 Other commands which manipulate the work tree may be used for
883 conflict resolution purposes.
890 Abort an interrupted rebase operation.
891 If this option is used, no other command-line arguments are allowed.
893 Continue an interrupted rebase operation.
894 If this option is used, no other command-line arguments are allowed.
899 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
900 Edit commit history between the work tree's current base commit and
901 the tip commit of the work tree's current branch.
903 Editing of commit history is controlled via a
905 which can be edited interactively or passed on the command line.
906 The format of the histedit script is line-based.
907 Each line in the script begins with a command name, followed by
908 whitespace and an argument.
909 For most commands, the expected argument is a commit ID SHA1 hash.
910 Any remaining text on the line is ignored.
911 Lines which begin with the
913 character are ignored entirely.
915 The available commands are as follows:
916 .Bl -column YXZ pick-commit
917 .It pick Ar commit Ta Use the specified commit as it is.
918 .It edit Ar commit Ta Use the specified commit but once changes have been
919 merged into the work tree interrupt the histedit operation for amending.
920 .It fold Ar commit Ta Combine the specified commit with the next commit
921 listed further below that will be used.
922 .It drop Ar commit Ta Remove this commit from the edited history.
923 .It mesg Ar log-message Ta Use the specified single-line log message for
924 the commit on the previous line.
925 If the log message argument is left empty, open an editor where a new
926 log message can be written.
929 Every commit in the history being edited must be mentioned in the script.
930 Lines may be re-ordered to change the order of commits in the edited history.
932 Edited commits are accumulated on a temporary branch which the work tree
933 will remain switched to throughout the entire histedit operation.
934 Once history editing has completed successfully, the temporary branch becomes
935 the new version of the work tree's branch and the work tree is automatically
938 While merging commits, show the status of each affected file,
939 using the following status codes:
940 .Bl -column YXZ description
941 .It G Ta file was merged
942 .It C Ta file was merged and conflicts occurred during merge
943 .It ! Ta changes destined for a missing file were not merged
944 .It D Ta file was deleted
945 .It d Ta file's deletion was obstructed by local modifications
946 .It A Ta new file was added
947 .It \(a~ Ta changes destined for a non-regular file were not merged
950 If merge conflicts occur the histedit operation is interrupted and may
951 be continued once conflicts have been resolved.
952 Alternatively, the histedit operation may be aborted which will leave
953 the work tree switched back to its original branch.
955 If a merge conflict is resolved in a way which renders the merged
956 change into a no-op change, the corresponding commit will be elided
957 when the histedit operation continues.
960 will refuse to run if certain preconditions are not met.
961 If the work tree's current branch is not in the
963 reference namespace, the history of the branch may not be edited.
964 If the work tree contains multiple base commits it must first be updated
965 to a single base commit with
967 If changes have been staged with
969 these changes must first be committed with
973 If the work tree contains local changes, these changes must first be
978 If the edited history contains changes to files outside of the work tree's
979 path prefix, the work tree cannot be used to edit the history of this branch.
983 command will refuse to run while a histedit operation is in progress.
984 Other commands which manipulate the work tree may be used, and the
986 command may be used to commit arbitrary changes to the temporary branch
987 while the histedit operation is interrupted.
994 Abort an interrupted histedit operation.
995 If this option is used, no other command-line arguments are allowed.
997 Continue an interrupted histedit operation.
998 If this option is used, no other command-line arguments are allowed.
1003 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1004 Stage local changes for inclusion in the next commit.
1007 is specified, stage all changes in the work tree.
1008 Otherwise, stage changes at or within the specified paths.
1009 Paths may be staged if they are added, modified, or deleted according to
1012 Show the status of each affected file, using the following status codes:
1013 .Bl -column YXZ description
1014 .It A Ta file addition has been staged
1015 .It M Ta file modification has been staged
1016 .It D Ta file deletion has been staged
1019 Staged file contents are saved in newly created blob objects in the repository.
1020 These blobs will be referred to by tree objects once staged changes have been
1023 Staged changes affect the behaviour of
1028 While paths with staged changes exist, the
1030 command will refuse to commit any paths which do not have staged changes.
1031 Local changes created on top of staged changes can only be committed if
1032 the path is staged again, or if the staged changes are committed first.
1035 command will show both local changes and staged changes.
1038 command is able to display local changes relative to staged changes,
1039 and to display staged changes relative to the repository.
1042 command cannot revert staged changes but may be used to revert
1043 local changes created on top of staged changes.
1050 Instead of staging new changes, list paths which are already staged,
1051 along with the IDs of staged blob objects and stage status codes.
1052 If paths were provided in the command line show the staged paths
1053 among the specified paths.
1054 Otherwise, show all staged paths.
1056 Instead of staging the entire content of a changed file, interactively
1057 select or reject changes for staging based on
1061 (reject change), and
1063 (quit staging this file) responses.
1064 If a file is in modified status, individual patches derived from the
1065 modified file content can be staged.
1066 Files in added or deleted status may only be staged or rejected in
1068 .It Fl F Ar response-script
1076 responses line-by-line from the specified
1078 file instead of prompting interactively.
1082 will refuse to run if certain preconditions are not met.
1083 If a file contains merge conflicts, these conflicts must be resolved first.
1084 If a file is found to be out of date relative to the head commit on the
1085 work tree's current branch, the file must be updated with
1087 before it can be staged (however, this does not prevent the file from
1088 becoming out-of-date at some point after having been staged).
1095 commands will refuse to run while staged changes exist.
1096 If staged changes cannot be committed because a staged path
1097 is out of date, the path must be unstaged with
1099 before it can be updated with
1101 and may then be staged again if necessary.
1105 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1106 Merge staged changes back into the work tree and put affected paths
1107 back into non-staged status.
1110 is specified, unstage all staged changes across the entire work tree.
1111 Otherwise, unstage changes at or within the specified paths.
1113 Show the status of each affected file, using the following status codes:
1114 .Bl -column YXZ description
1115 .It G Ta file was unstaged
1116 .It C Ta file was unstaged and conflicts occurred during merge
1117 .It ! Ta changes destined for a missing file were not merged
1118 .It D Ta file was staged as deleted and still is deleted
1119 .It d Ta file's deletion was obstructed by local modifications
1120 .It \(a~ Ta changes destined for a non-regular file were not merged
1128 Instead of unstaging the entire content of a changed file, interactively
1129 select or reject changes for unstaging based on
1133 (keep change staged), and
1135 (quit unstaging this file) responses.
1136 If a file is staged in modified status, individual patches derived from the
1137 staged file content can be unstaged.
1138 Files staged in added or deleted status may only be unstaged in their entirety.
1139 .It Fl F Ar response-script
1147 responses line-by-line from the specified
1149 file instead of prompting interactively.
1154 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar arg ...
1155 Parse and print contents of objects to standard output in a line-based
1157 Content of commit, tree, and tag objects is printed in a way similar
1158 to the actual content stored in such objects.
1159 Blob object contents are printed as they would appear in files on disk.
1161 Attempt to interpret each argument as a reference, a tag name, or
1162 an object ID SHA1 hash.
1163 References will be resolved to an object ID.
1164 Tag names will resolved to a tag object.
1165 An abbreviated hash argument will be expanded to a full SHA1 hash
1166 automatically, provided the abbreviation is unique.
1168 If none of the above interpretations produce a valid result, or if the
1170 option is used, attempt to interpret the argument as a path which will
1171 be resolved to the ID of an object found at this path in the repository.
1178 Look up paths in the specified
1180 If this option is not used, paths are looked up in the commit resolved
1181 via the repository's HEAD reference.
1182 The expected argument is a commit ID SHA1 hash or an existing reference
1183 or tag name which will be resolved to a commit ID.
1184 An abbreviated hash argument will be expanded to a full SHA1 hash
1185 automatically, provided the abbreviation is unique.
1186 .It Fl r Ar repository-path
1187 Use the repository at the specified path.
1188 If not specified, assume the repository is located at or above the current
1190 If this directory is a
1192 work tree, use the repository path associated with this work tree.
1194 Interpret all arguments as paths only.
1195 This option can be used to resolve ambiguity in cases where paths
1196 look like tag names, reference names, or object IDs.
1200 .Bl -tag -width GOT_AUTHOR
1202 The author's name and email address for
1207 .An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1210 may fail to parse commits without an email address in author data,
1214 environment variables with a missing email address.
1215 .It Ev VISUAL , EDITOR
1216 The editor spawned by
1221 .It Ev GOT_LOG_DEFAULT_LIMIT
1222 The default limit on the number of commits traversed by
1224 If set to zero, the limit is unbounded.
1225 This variable will be silently ignored if it is set to a non-numeric value.
1230 Clone an existing Git repository for use with
1232 This step currently requires
1236 .Dl $ git clone --bare https://github.com/openbsd/src.git
1238 Alternatively, for quick and dirty local testing of
1240 a new Git repository could be created and populated with files,
1241 e.g. from a temporary CVS checkout located at
1244 .Dl $ got init /var/git/src.git
1245 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1247 Check out a work tree from the Git repository to /usr/src:
1249 .Dl $ got checkout /var/git/src.git /usr/src
1251 View local changes in a work tree directory:
1254 .Dl $ got diff | less
1256 Interactively revert selected local changes in a work tree directory:
1258 .Dl $ got revert -p -R\ .
1260 In a work tree or a git repository directory, list all branch references:
1264 In a work tree or a git repository directory, create a new branch called
1265 .Dq unified-buffer-cache
1266 which is forked off the
1270 .Dl $ got branch unified-buffer-cache master
1272 Switch an existing work tree to the branch
1273 .Dq unified-buffer-cache .
1274 Local changes in the work tree will be preserved and merged if necessary:
1276 .Dl $ got update -b unified-buffer-cache
1278 Create a new commit from local changes in a work tree directory.
1279 This new commit will become the head commit of the work tree's current branch:
1283 In a work tree or a git repository directory, view changes committed in
1284 the 3 most recent commits to the work tree's branch, or the branch resolved
1285 via the repository's HEAD reference, respectively:
1287 .Dl $ got log -p -l 3 -f
1289 Add new files and remove obsolete files in a work tree directory:
1291 .Dl $ got add sys/uvm/uvm_ubc.c
1292 .Dl $ got remove sys/uvm/uvm_vnode.c
1294 Create a new commit from local changes in a work tree directory
1295 with a pre-defined log message.
1297 .Dl $ got commit -m 'unify the buffer cache'
1299 Update any work tree checked out from the
1300 .Dq unified-buffer-cache
1301 branch to the latest commit on this branch:
1305 Roll file content on the unified-buffer-cache branch back by one commit,
1306 and then fetch the rolled-back change into the work tree as a local change
1307 to be amended and perhaps committed again:
1309 .Dl $ got backout unified-buffer-cache
1310 .Dl $ got commit -m 'roll back previous'
1311 .Dl $ # now back out the previous backout :-)
1312 .Dl $ got backout unified-buffer-cache
1314 Fetch new upstream commits into the local repository's master branch.
1315 This step currently requires
1318 .Dl $ cd /var/git/src.git
1319 .Dl $ git fetch origin master:master
1322 .Dq unified-buffer-cache
1323 branch on top of the new head commit of the
1327 .Dl $ got update -b master
1328 .Dl $ got rebase unified-buffer-cache
1330 Create a patch from all changes on the unified-buffer-cache branch.
1331 The patch can be mailed out for review and applied to
1335 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1337 Edit the entire commit history of the
1338 .Dq unified-buffer-cache
1341 .Dl $ got update -b unified-buffer-cache
1342 .Dl $ got update -c master
1345 Additional steps are necessary if local changes need to be pushed back
1346 to the remote repository, which currently requires
1350 Before working against existing branches in a repository cloned with
1351 .Dq git clone --bare ,
1354 must be configured to map all references in the remote repository
1357 namespace of the local repository.
1358 This can achieved by setting Git's
1359 .Pa remote.origin.fetch
1360 configuration variable to the value
1361 .Dq +refs/heads/*:refs/remotes/origin/*
1366 .Dl $ cd /var/git/repo
1367 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1369 Alternatively, the following
1371 configuration item can be added manually to the Git repository's
1375 .Dl [remote "origin"]
1377 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1379 This configuration leaves the local repository's
1381 namespace free for use by local branches checked out with
1383 and, if needed, created with
1388 namespace can be updated with incoming changes from the remote
1392 .Dl $ cd /var/git/repo
1395 Before outgoing changes on the local
1397 branch can be pushed to the remote repository, the local
1399 branch must be rebased onto the
1403 .Dl $ got update -b origin/master
1404 .Dl $ got rebase master
1406 Changes on the local
1408 branch can then be pushed to the remote
1412 .Dl $ cd /var/git/repo
1413 .Dl $ git push origin master
1416 .Xr git-repository 5 ,
1419 .An Stefan Sperling Aq Mt stsp@openbsd.org
1420 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1421 .An Joshua Stein Aq Mt jcs@openbsd.org
1424 is a work-in-progress and many commands remain to be implemented.
1425 At present, the user has to fall back on
1427 to perform many tasks, in particular tasks related to repository
1428 administration and tasks which require a network connection.
