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,
98 configuration settings can be obtained from the repository's
100 file or from Git's global
111 instead of creating the default branch
113 Use of this option is required if the
115 branch already exists.
117 Use the specified log message when creating the new commit.
122 opens a temporary file in an editor where a log message can be written.
123 .It Fl r Ar repository-path
124 Use the repository at the specified path.
125 If not specified, assume the repository is located at or above the current
128 Ignore files or directories with a name which matches the specified
130 This option may be specified multiple times to build a list of ignore patterns.
133 follows the globbing rules documented in
139 .It Cm checkout Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
140 Copy files from a repository into a new work tree.
143 is not specified, either use the last component of
144 .Ar repository path ,
147 was specified use the last component of
155 Check out files from a commit on the specified
157 If this option is not specified, a branch resolved via the repository's HEAD
158 reference will be used.
160 Check out files from the specified
162 on the selected branch.
163 The expected argument is a commit ID SHA1 hash or an existing reference
164 or tag name which will be resolved to a commit ID.
165 An abbreviated hash argument will be expanded to a full SHA1 hash
166 automatically, provided the abbreviation is unique.
167 If this option is not specified, the most recent commit on the selected
169 .It Fl p Ar path-prefix
170 Restrict the work tree to a subset of the repository's tree hierarchy.
171 Only files beneath the specified
178 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
179 Update an existing work tree to a different commit.
180 Show the status of each affected file, using the following status codes:
181 .Bl -column YXZ description
182 .It U Ta file was updated and contained no local changes
183 .It G Ta file was updated and local changes were merged cleanly
184 .It C Ta file was updated and conflicts occurred during merge
185 .It D Ta file was deleted
186 .It A Ta new file was added
187 .It \(a~ Ta versioned file is obstructed by a non-regular file
188 .It ! Ta a missing versioned file was restored
193 is specified, update the entire work tree.
194 Otherwise, restrict the update operation to files at or within the
196 Each path is required to exist in the update operation's target commit.
197 Files in the work tree outside specified paths will remain unchanged and
198 will retain their previously recorded base commit.
201 commands may refuse to run while the work tree contains files from
202 multiple base commits.
203 The base commit of such a work tree can be made consistent by running
205 across the entire work tree.
208 is incompatible with the
213 cannot update paths with staged changes.
214 If changes have been staged with
216 these changes must first be committed with
226 Switch the work tree's branch reference to the specified
228 before updating the work tree.
229 This option requires that all paths in the work tree are updated.
231 Update the work tree to the specified
233 The expected argument is a commit ID SHA1 hash or an existing reference
234 or tag name which will be resolved to a commit ID.
235 An abbreviated hash argument will be expanded to a full SHA1 hash
236 automatically, provided the abbreviation is unique.
237 If this option is not specified, the most recent commit on the work tree's
243 .It Cm status Op Ar path ...
244 Show the current modification status of files in a work tree,
245 using the following status codes:
246 .Bl -column YXZ description
247 .It M Ta modified file
248 .It A Ta file scheduled for addition in next commit
249 .It D Ta file scheduled for deletion in next commit
250 .It C Ta modified or added file which contains merge conflicts
251 .It ! Ta versioned file was expected on disk but is missing
252 .It \(a~ Ta versioned file is obstructed by a non-regular file
253 .It ? Ta unversioned item not tracked by
255 .It N Ta non-existent
257 specified on the command line
262 is specified, show modifications in the entire work tree.
263 Otherwise, show modifications at or within the specified paths.
265 If changes have been staged with
267 staged changes are shown in the second output column, using the following
269 .Bl -column YXZ description
270 .It M Ta file modification is staged
271 .It A Ta file addition is staged
272 .It D Ta file deletion is staged
275 Changes created on top of staged changes are indicated in the first column:
276 .Bl -column YXZ description
277 .It MM Ta file was modified after earlier changes have been staged
278 .It MA Ta file was modified after having been staged for addition
281 For compatibility with
292 files in each traversed directory and will not display unversioned files
293 which match these patterns.
298 supports consecutive asterisks,
300 which will match an arbitrary amount of directories.
304 only supports a single ignore pattern per line.
308 does not support negated ignore patterns prefixed with
310 and gives no special significance to the location of path component separators,
316 .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
317 Display history of a repository.
320 is specified, show only commits which modified this path.
327 Start traversing history at the specified
329 The expected argument is a commit ID SHA1 hash or an existing reference
330 or tag name which will be resolved to a commit ID.
331 An abbreviated hash argument will be expanded to a full SHA1 hash
332 automatically, provided the abbreviation is unique.
333 If this option is not specified, default to the work tree's current branch
334 if invoked in a work tree, or to the repository's HEAD reference.
336 Set the number of context lines shown in diffs with
338 By default, 3 lines of context are shown.
340 Restrict history traversal to the first parent of each commit.
341 This shows the linear history of the current branch only.
342 Merge commits which affected the current branch will be shown but
343 individual commits which originated on other branches will be omitted.
345 Limit history traversal to a given number of commits.
346 If this option is not specified, a default limit value of zero is used,
347 which is treated as an unbounded limit.
349 .Ev GOT_LOG_DEFAULT_LIMIT
350 environment variable may be set to change this default value.
352 Display the patch of modifications made in each commit.
355 is specified, only show the patch of modifications at or within this path.
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 .It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path
365 When invoked within a work tree with less than two arguments, display
366 uncommitted changes in the work tree.
369 is specified, only show changes within this path.
371 If two arguments are provided, treat each argument as a reference, a tag
372 name, or an object ID SHA1 hash, and display differences between the
373 corresponding objects.
374 Both objects must be of the same type (blobs, trees, or commits).
375 An abbreviated hash argument will be expanded to a full SHA1 hash
376 automatically, provided the abbreviation is unique.
383 Set the number of context lines shown in the diff.
384 By default, 3 lines of context are shown.
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.
393 Show changes staged with
395 instead of showing local changes.
396 This option is only valid when
398 is invoked in a work tree.
400 Ignore whitespace-only changes.
405 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
406 Display line-by-line history of a file at the specified path.
413 Start traversing history at the specified
415 The expected argument is a commit ID SHA1 hash or an existing reference
416 or tag name which will be resolved to a commit ID.
417 An abbreviated hash argument will be expanded to a full SHA1 hash
418 automatically, provided the abbreviation is unique.
419 .It Fl r Ar repository-path
420 Use the repository at the specified path.
421 If not specified, assume the repository is located at or above the current
423 If this directory is a
425 work tree, use the repository path associated with this work tree.
430 .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
431 Display a listing of files and directories at the specified
432 directory path in the repository.
433 Entries shown in this listing may carry one of the following trailing
435 .Bl -column YXZ description
436 .It @ Ta entry is a symbolic link
437 .It / Ta entry is a directory
438 .It * Ta entry is an executable file
439 .It $ Ta entry is a Git submodule
444 is specified, list the repository path corresponding to the current
445 directory of the work tree, or the root directory of the repository
446 if there is no work tree.
453 List files and directories as they appear in the specified
455 The expected argument is a commit ID SHA1 hash or an existing reference
456 or tag name which will be resolved to a commit ID.
457 An abbreviated hash argument will be expanded to a full SHA1 hash
458 automatically, provided the abbreviation is unique.
459 .It Fl r Ar repository-path
460 Use the repository at the specified path.
461 If not specified, assume the repository is located at or above the current
463 If this directory is a
465 work tree, use the repository path associated with this work tree.
467 Show object IDs of files (blob objects) and directories (tree objects).
469 Recurse into sub-directories in the repository.
474 .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
475 Manage references in a repository.
477 If no options are passed, expect two arguments and attempt to create,
478 or update, the reference with the given
480 and make it point at the given
482 The target may be an object ID SHA1 hash or an existing reference which
483 will be resolved to an object ID.
484 An abbreviated hash argument will be expanded to a full SHA1 hash
485 automatically, provided the abbreviation is unique.
491 .It Fl r Ar repository-path
492 Use the repository at the specified path.
493 If not specified, assume the repository is located at or above the current
495 If this directory is a
497 work tree, use the repository path associated with this work tree.
499 List all existing references in the repository.
501 Delete the reference with the specified name from the repository.
503 Create a symbolic reference pointing at the specified
505 which must be an existing reference.
506 Care should be taken not to create loops between references when
509 .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
510 Manage branches in a repository.
512 Branches are managed via references which live in the
517 command operates on references in this namespace only.
519 If invoked in a work tree without any arguments, print the name of the
520 work tree's current branch.
521 If one or two arguments are passed, attempt to create a branch reference
524 and make it point at the given
528 argument is a commit ID SHA1 hash or an existing reference
529 or tag name which will be resolved to a commit ID.
532 is specified, default to the latest commit on the work tree's current
533 branch if invoked in a work tree, or to a commit resolved via the
534 repository's HEAD reference.
540 .It Fl r Ar repository-path
541 Use the repository at the specified path.
542 If not specified, assume the repository is located at or above the current
544 If this directory is a
546 work tree, use the repository path associated with this work tree.
548 List all existing branches in the repository.
549 If invoked in a work tree, the work tree's current branch is shown
550 with one the following annotations:
551 .Bl -column YXZ description
552 .It * Ta work tree's base commit matches the branch tip
553 .It \(a~ Ta work tree's base commit is out-of-date
556 Delete the branch with the specified name from the repository.
557 Only the branch reference is deleted.
558 Any commit, tree, and blob objects belonging to the branch
559 remain in the repository and may be removed separately with
560 Git's garbage collector.
565 .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
566 Manage tags in a repository.
568 Tags are managed via references which live in the
573 command operates on references in this namespace only.
574 References in this namespace point at tag objects which contain a pointer
575 to another object, a tag message, as well as author and timestamp information.
577 Expect one or two arguments and attempt to create a tag with the given
579 and make this tag point at the given
581 If no commit is specified, default to the latest commit on the work tree's
582 current branch if invoked in a work tree, and to a commit resolved via
583 the repository's HEAD reference otherwise.
584 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
585 reference or tag name which will be resolved to a commit ID.
586 An abbreviated hash argument will be expanded to a full SHA1 hash
587 automatically, provided the abbreviation is unique.
594 Use the specified tag message when creating the new tag
599 opens a temporary file in an editor where a tag message can be written.
600 .It Fl r Ar repository-path
601 Use the repository at the specified path.
602 If not specified, assume the repository is located at or above the current
604 If this directory is a
606 work tree, use the repository path associated with this work tree.
608 List all existing tags in the repository instead of creating a new tag.
609 If this option is used, no other command-line arguments are allowed.
614 command will not delete tags or change existing tags.
615 If a tag must be deleted, the
617 command may be used to delete a tag's reference.
618 This should only be done if the tag has not already been copied to
620 .It Cm add Ar file-path ...
621 Schedule unversioned files in a work tree for addition to the
622 repository in the next commit.
623 .It Cm remove Ar file-path ...
624 Remove versioned files from a work tree and schedule them for deletion
625 from the repository in the next commit.
632 Perform the operation even if a file contains uncommitted modifications.
637 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
638 Revert any uncommitted changes in files at the specified paths.
639 File contents will be overwritten with those contained in the
640 work tree's base commit.
641 There is no way to bring discarded changes back after
644 If a file was added with
646 it will become an unversioned file again.
647 If a file was deleted with
656 Instead of reverting all changes in files, interactively select or reject
657 changes to revert based on
663 (quit reverting this file) responses.
664 If a file is in modified status, individual patches derived from the
665 modified file content can be reverted.
666 Files in added or deleted status may only be reverted in their entirety.
667 .It Fl F Ar response-script
675 responses line-by-line from the specified
677 file instead of prompting interactively.
679 Permit recursion into directories.
680 If this option is not specified,
682 will refuse to run if a specified
689 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
690 Create a new commit in the repository from changes in a work tree
691 and use this commit as the new base commit for the work tree.
694 is specified, commit all changes in the work tree.
695 Otherwise, commit changes at or within the specified paths.
697 If changes have been explicitly staged for commit with
699 only commit staged changes and reject any specified paths which
700 have not been staged.
702 Show the status of each affected file, using the following status codes:
703 .Bl -column YXZ description
704 .It M Ta modified file
705 .It D Ta file was deleted
706 .It A Ta new file was added
709 Files which are not part of the new commit will retain their previously
710 recorded base commit.
713 commands may refuse to run while the work tree contains files from
714 multiple base commits.
715 The base commit of such a work tree can be made consistent by running
717 across the entire work tree.
723 environment variable to be set,
728 configuration settings can be
729 obtained from the repository's
731 file or from Git's global
740 Use the specified log message when creating the new commit.
745 opens a temporary file in an editor where a log message can be written.
749 will refuse to run if certain preconditions are not met.
750 If the work tree's current branch is not in the
752 reference namespace, new commits may not be created on this branch.
753 Local changes may only be committed if they are based on file content
754 found in the most recent commit on the work tree's branch.
755 If a path is found to be out of date,
757 must be used first in order to merge local changes with changes made
762 .It Cm cherrypick Ar commit
763 Merge changes from a single
768 must be on a different branch than the work tree's base commit.
769 The expected argument is a reference or a commit ID SHA1 hash.
770 An abbreviated hash argument will be expanded to a full SHA1 hash
771 automatically, provided the abbreviation is unique.
773 Show the status of each affected file, using the following status codes:
774 .Bl -column YXZ description
775 .It G Ta file was merged
776 .It C Ta file was merged and conflicts occurred during merge
777 .It ! Ta changes destined for a missing file were not merged
778 .It D Ta file was deleted
779 .It d Ta file's deletion was obstructed by local modifications
780 .It A Ta new file was added
781 .It \(a~ Ta changes destined for a non-regular file were not merged
784 The merged changes will appear as local changes in the work tree, which
787 amended manually or with further
792 or discarded again with
796 will refuse to run if certain preconditions are not met.
797 If the work tree contains multiple base commits it must first be updated
798 to a single base commit with
800 If the work tree already contains files with merge conflicts, these
801 conflicts must be resolved first.
805 .It Cm backout Ar commit
806 Reverse-merge changes from a single
811 must be on the same branch as the work tree's base commit.
812 The expected argument is a reference or a commit ID SHA1 hash.
813 An abbreviated hash argument will be expanded to a full SHA1 hash
814 automatically, provided the abbreviation is unique.
816 Show the status of each affected file, using the following status codes:
817 .Bl -column YXZ description
818 .It G Ta file was merged
819 .It C Ta file was merged and conflicts occurred during merge
820 .It ! Ta changes destined for a missing file were not merged
821 .It D Ta file was deleted
822 .It d Ta file's deletion was obstructed by local modifications
823 .It A Ta new file was added
824 .It \(a~ Ta changes destined for a non-regular file were not merged
827 The reverse-merged changes will appear as local changes in the work tree,
828 which may be viewed with
830 amended manually or with further
835 or discarded again with
839 will refuse to run if certain preconditions are not met.
840 If the work tree contains multiple base commits it must first be updated
841 to a single base commit with
843 If the work tree already contains files with merge conflicts, these
844 conflicts must be resolved first.
848 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
849 Rebase commits on the specified
851 onto the tip of the current branch of the work tree.
854 must share common ancestry with the work tree's current branch.
855 Rebasing begins with the first descendant commit of the youngest
856 common ancestor commit shared by the specified
858 and the work tree's current branch, and stops once the tip commit
863 Rebased commits are accumulated on a temporary branch which the work tree
864 will remain switched to throughout the entire rebase operation.
865 Commits on this branch represent the same changes with the same log
866 messages as their counterparts on the original
868 but with different commit IDs.
869 Once rebasing has completed successfully, the temporary branch becomes
870 the new version of the specified
872 and the work tree is automatically switched to it.
874 While rebasing commits, show the status of each affected file,
875 using the following status codes:
876 .Bl -column YXZ description
877 .It G Ta file was merged
878 .It C Ta file was merged and conflicts occurred during merge
879 .It ! Ta changes destined for a missing file were not merged
880 .It D Ta file was deleted
881 .It d Ta file's deletion was obstructed by local modifications
882 .It A Ta new file was added
883 .It \(a~ Ta changes destined for a non-regular file were not merged
886 If merge conflicts occur the rebase operation is interrupted and may
887 be continued once conflicts have been resolved.
888 Alternatively, the rebase operation may be aborted which will leave
890 unmodified and the work tree switched back to its original branch.
892 If a merge conflict is resolved in a way which renders the merged
893 change into a no-op change, the corresponding commit will be elided
894 when the rebase operation continues.
897 will refuse to run if certain preconditions are not met.
898 If the work tree contains multiple base commits it must first be updated
899 to a single base commit with
901 If changes have been staged with
903 these changes must first be committed with
907 If the work tree contains local changes, these changes must first be
914 contains changes to files outside of the work tree's path prefix,
915 the work tree cannot be used to rebase this branch.
921 commands will refuse to run while a rebase operation is in progress.
922 Other commands which manipulate the work tree may be used for
923 conflict resolution purposes.
930 Abort an interrupted rebase operation.
931 If this option is used, no other command-line arguments are allowed.
933 Continue an interrupted rebase operation.
934 If this option is used, no other command-line arguments are allowed.
939 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
940 Edit commit history between the work tree's current base commit and
941 the tip commit of the work tree's current branch.
943 Editing of commit history is controlled via a
945 which can be edited interactively or passed on the command line.
946 The format of the histedit script is line-based.
947 Each line in the script begins with a command name, followed by
948 whitespace and an argument.
949 For most commands, the expected argument is a commit ID SHA1 hash.
950 Any remaining text on the line is ignored.
951 Lines which begin with the
953 character are ignored entirely.
955 The available commands are as follows:
956 .Bl -column YXZ pick-commit
957 .It pick Ar commit Ta Use the specified commit as it is.
958 .It edit Ar commit Ta Use the specified commit but once changes have been
959 merged into the work tree interrupt the histedit operation for amending.
960 .It fold Ar commit Ta Combine the specified commit with the next commit
961 listed further below that will be used.
962 .It drop Ar commit Ta Remove this commit from the edited history.
963 .It mesg Ar log-message Ta Use the specified single-line log message for
964 the commit on the previous line.
965 If the log message argument is left empty, open an editor where a new
966 log message can be written.
969 Every commit in the history being edited must be mentioned in the script.
970 Lines may be re-ordered to change the order of commits in the edited history.
972 Edited commits are accumulated on a temporary branch which the work tree
973 will remain switched to throughout the entire histedit operation.
974 Once history editing has completed successfully, the temporary branch becomes
975 the new version of the work tree's branch and the work tree is automatically
978 While merging commits, show the status of each affected file,
979 using the following status codes:
980 .Bl -column YXZ description
981 .It G Ta file was merged
982 .It C Ta file was merged and conflicts occurred during merge
983 .It ! Ta changes destined for a missing file were not merged
984 .It D Ta file was deleted
985 .It d Ta file's deletion was obstructed by local modifications
986 .It A Ta new file was added
987 .It \(a~ Ta changes destined for a non-regular file were not merged
990 If merge conflicts occur the histedit operation is interrupted and may
991 be continued once conflicts have been resolved.
992 Alternatively, the histedit operation may be aborted which will leave
993 the work tree switched back to its original branch.
995 If a merge conflict is resolved in a way which renders the merged
996 change into a no-op change, the corresponding commit will be elided
997 when the histedit operation continues.
1000 will refuse to run if certain preconditions are not met.
1001 If the work tree's current branch is not in the
1003 reference namespace, the history of the branch may not be edited.
1004 If the work tree contains multiple base commits it must first be updated
1005 to a single base commit with
1007 If changes have been staged with
1009 these changes must first be committed with
1013 If the work tree contains local changes, these changes must first be
1018 If the edited history contains changes to files outside of the work tree's
1019 path prefix, the work tree cannot be used to edit the history of this branch.
1023 command will refuse to run while a histedit operation is in progress.
1024 Other commands which manipulate the work tree may be used, and the
1026 command may be used to commit arbitrary changes to the temporary branch
1027 while the histedit operation is interrupted.
1034 Abort an interrupted histedit operation.
1035 If this option is used, no other command-line arguments are allowed.
1037 Continue an interrupted histedit operation.
1038 If this option is used, no other command-line arguments are allowed.
1043 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1044 Stage local changes for inclusion in the next commit.
1047 is specified, stage all changes in the work tree.
1048 Otherwise, stage changes at or within the specified paths.
1049 Paths may be staged if they are added, modified, or deleted according to
1052 Show the status of each affected file, using the following status codes:
1053 .Bl -column YXZ description
1054 .It A Ta file addition has been staged
1055 .It M Ta file modification has been staged
1056 .It D Ta file deletion has been staged
1059 Staged file contents are saved in newly created blob objects in the repository.
1060 These blobs will be referred to by tree objects once staged changes have been
1063 Staged changes affect the behaviour of
1068 While paths with staged changes exist, the
1070 command will refuse to commit any paths which do not have staged changes.
1071 Local changes created on top of staged changes can only be committed if
1072 the path is staged again, or if the staged changes are committed first.
1075 command will show both local changes and staged changes.
1078 command is able to display local changes relative to staged changes,
1079 and to display staged changes relative to the repository.
1082 command cannot revert staged changes but may be used to revert
1083 local changes created on top of staged changes.
1090 Instead of staging new changes, list paths which are already staged,
1091 along with the IDs of staged blob objects and stage status codes.
1092 If paths were provided in the command line show the staged paths
1093 among the specified paths.
1094 Otherwise, show all staged paths.
1096 Instead of staging the entire content of a changed file, interactively
1097 select or reject changes for staging based on
1101 (reject change), and
1103 (quit staging this file) responses.
1104 If a file is in modified status, individual patches derived from the
1105 modified file content can be staged.
1106 Files in added or deleted status may only be staged or rejected in
1108 .It Fl F Ar response-script
1116 responses line-by-line from the specified
1118 file instead of prompting interactively.
1122 will refuse to run if certain preconditions are not met.
1123 If a file contains merge conflicts, these conflicts must be resolved first.
1124 If a file is found to be out of date relative to the head commit on the
1125 work tree's current branch, the file must be updated with
1127 before it can be staged (however, this does not prevent the file from
1128 becoming out-of-date at some point after having been staged).
1135 commands will refuse to run while staged changes exist.
1136 If staged changes cannot be committed because a staged path
1137 is out of date, the path must be unstaged with
1139 before it can be updated with
1141 and may then be staged again if necessary.
1145 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1146 Merge staged changes back into the work tree and put affected paths
1147 back into non-staged status.
1150 is specified, unstage all staged changes across the entire work tree.
1151 Otherwise, unstage changes at or within the specified paths.
1153 Show the status of each affected file, using the following status codes:
1154 .Bl -column YXZ description
1155 .It G Ta file was unstaged
1156 .It C Ta file was unstaged and conflicts occurred during merge
1157 .It ! Ta changes destined for a missing file were not merged
1158 .It D Ta file was staged as deleted and still is deleted
1159 .It d Ta file's deletion was obstructed by local modifications
1160 .It \(a~ Ta changes destined for a non-regular file were not merged
1168 Instead of unstaging the entire content of a changed file, interactively
1169 select or reject changes for unstaging based on
1173 (keep change staged), and
1175 (quit unstaging this file) responses.
1176 If a file is staged in modified status, individual patches derived from the
1177 staged file content can be unstaged.
1178 Files staged in added or deleted status may only be unstaged in their entirety.
1179 .It Fl F Ar response-script
1187 responses line-by-line from the specified
1189 file instead of prompting interactively.
1194 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1195 Parse and print contents of objects to standard output in a line-based
1197 Content of commit, tree, and tag objects is printed in a way similar
1198 to the actual content stored in such objects.
1199 Blob object contents are printed as they would appear in files on disk.
1201 Attempt to interpret each argument as a reference, a tag name, or
1202 an object ID SHA1 hash.
1203 References will be resolved to an object ID.
1204 Tag names will resolved to a tag object.
1205 An abbreviated hash argument will be expanded to a full SHA1 hash
1206 automatically, provided the abbreviation is unique.
1208 If none of the above interpretations produce a valid result, or if the
1210 option is used, attempt to interpret the argument as a path which will
1211 be resolved to the ID of an object found at this path in the repository.
1218 Look up paths in the specified
1220 If this option is not used, paths are looked up in the commit resolved
1221 via the repository's HEAD reference.
1222 The expected argument is a commit ID SHA1 hash or an existing reference
1223 or tag name which will be resolved to a commit ID.
1224 An abbreviated hash argument will be expanded to a full SHA1 hash
1225 automatically, provided the abbreviation is unique.
1226 .It Fl r Ar repository-path
1227 Use the repository at the specified path.
1228 If not specified, assume the repository is located at or above the current
1230 If this directory is a
1232 work tree, use the repository path associated with this work tree.
1234 Interpret all arguments as paths only.
1235 This option can be used to resolve ambiguity in cases where paths
1236 look like tag names, reference names, or object IDs.
1240 .Bl -tag -width GOT_AUTHOR
1242 The author's name and email address for
1247 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1250 may fail to parse commits without an email address in author data,
1254 environment variables with a missing email address.
1260 configuration settings in the repository's
1262 file will override the value of
1268 configuration settings contained in Git's global
1270 configuration file will be used only if the
1272 environment variable is
1275 .It Ev VISUAL , EDITOR
1276 The editor spawned by
1281 .It Ev GOT_LOG_DEFAULT_LIMIT
1282 The default limit on the number of commits traversed by
1284 If set to zero, the limit is unbounded.
1285 This variable will be silently ignored if it is set to a non-numeric value.
1290 Clone an existing Git repository for use with
1292 This step currently requires
1296 .Dl $ git clone --bare https://github.com/openbsd/src.git
1298 Alternatively, for quick and dirty local testing of
1300 a new Git repository could be created and populated with files,
1301 e.g. from a temporary CVS checkout located at
1304 .Dl $ got init /var/git/src.git
1305 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1307 Check out a work tree from the Git repository to /usr/src:
1309 .Dl $ got checkout /var/git/src.git /usr/src
1311 View local changes in a work tree directory:
1314 .Dl $ got diff | less
1316 Interactively revert selected local changes in a work tree directory:
1318 .Dl $ got revert -p -R\ .
1320 In a work tree or a git repository directory, list all branch references:
1324 In a work tree or a git repository directory, create a new branch called
1325 .Dq unified-buffer-cache
1326 which is forked off the
1330 .Dl $ got branch unified-buffer-cache master
1332 Switch an existing work tree to the branch
1333 .Dq unified-buffer-cache .
1334 Local changes in the work tree will be preserved and merged if necessary:
1336 .Dl $ got update -b unified-buffer-cache
1338 Create a new commit from local changes in a work tree directory.
1339 This new commit will become the head commit of the work tree's current branch:
1343 In a work tree or a git repository directory, view changes committed in
1344 the 3 most recent commits to the work tree's branch, or the branch resolved
1345 via the repository's HEAD reference, respectively:
1347 .Dl $ got log -p -l 3 -f
1349 Add new files and remove obsolete files in a work tree directory:
1351 .Dl $ got add sys/uvm/uvm_ubc.c
1352 .Dl $ got remove sys/uvm/uvm_vnode.c
1354 Create a new commit from local changes in a work tree directory
1355 with a pre-defined log message.
1357 .Dl $ got commit -m 'unify the buffer cache'
1359 Update any work tree checked out from the
1360 .Dq unified-buffer-cache
1361 branch to the latest commit on this branch:
1365 Roll file content on the unified-buffer-cache branch back by one commit,
1366 and then fetch the rolled-back change into the work tree as a local change
1367 to be amended and perhaps committed again:
1369 .Dl $ got backout unified-buffer-cache
1370 .Dl $ got commit -m 'roll back previous'
1371 .Dl $ # now back out the previous backout :-)
1372 .Dl $ got backout unified-buffer-cache
1374 Fetch new upstream commits into the local repository's master branch.
1375 This step currently requires
1378 .Dl $ cd /var/git/src.git
1379 .Dl $ git fetch origin master:master
1382 .Dq unified-buffer-cache
1383 branch on top of the new head commit of the
1387 .Dl $ got update -b master
1388 .Dl $ got rebase unified-buffer-cache
1390 Create a patch from all changes on the unified-buffer-cache branch.
1391 The patch can be mailed out for review and applied to
1395 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1397 Edit the entire commit history of the
1398 .Dq unified-buffer-cache
1401 .Dl $ got update -b unified-buffer-cache
1402 .Dl $ got update -c master
1405 Additional steps are necessary if local changes need to be pushed back
1406 to the remote repository, which currently requires
1410 Before working against existing branches in a repository cloned with
1411 .Dq git clone --bare ,
1414 must be configured to map all references in the remote repository
1417 namespace of the local repository.
1418 This can achieved by setting Git's
1419 .Pa remote.origin.fetch
1420 configuration variable to the value
1421 .Dq +refs/heads/*:refs/remotes/origin/*
1426 .Dl $ cd /var/git/repo
1427 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1429 Alternatively, the following
1431 configuration item can be added manually to the Git repository's
1435 .Dl [remote "origin"]
1437 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1439 This configuration leaves the local repository's
1441 namespace free for use by local branches checked out with
1443 and, if needed, created with
1448 namespace can be updated with incoming changes from the remote
1452 .Dl $ cd /var/git/repo
1455 Before outgoing changes on the local
1457 branch can be pushed to the remote repository, the local
1459 branch must be rebased onto the
1463 .Dl $ got update -b origin/master
1464 .Dl $ got rebase master
1466 Changes on the local
1468 branch can then be pushed to the remote
1472 .Dl $ cd /var/git/repo
1473 .Dl $ git push origin master
1476 .Xr git-repository 5 ,
1479 .An Stefan Sperling Aq Mt stsp@openbsd.org
1480 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1481 .An Joshua Stein Aq Mt jcs@openbsd.org
1484 is a work-in-progress and many commands remain to be implemented.
1485 At present, the user has to fall back on
1487 to perform many tasks, in particular tasks related to repository
1488 administration and tasks which require a network connection.
