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 name must be an absolute reference name, i.e. it must begin with
484 The target may be an object ID SHA1 hash or an existing reference which
485 will be resolved to an object ID.
486 An abbreviated hash argument will be expanded to a full SHA1 hash
487 automatically, provided the abbreviation is unique.
493 .It Fl r Ar repository-path
494 Use the repository at the specified path.
495 If not specified, assume the repository is located at or above the current
497 If this directory is a
499 work tree, use the repository path associated with this work tree.
501 List all existing references in the repository.
503 Delete the reference with the specified name from the repository.
505 Create a symbolic reference pointing at the specified
507 which must be an existing reference.
508 Care should be taken not to create loops between references when
511 .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
512 Manage branches in a repository.
514 Branches are managed via references which live in the
519 command operates on references in this namespace only.
521 If invoked in a work tree without any arguments, print the name of the
522 work tree's current branch.
523 If one or two arguments are passed, attempt to create a branch reference
526 and make it point at the given
530 argument is a commit ID SHA1 hash or an existing reference
531 or tag name which will be resolved to a commit ID.
534 is specified, default to the latest commit on the work tree's current
535 branch if invoked in a work tree, or to a commit resolved via the
536 repository's HEAD reference.
542 .It Fl r Ar repository-path
543 Use the repository at the specified path.
544 If not specified, assume the repository is located at or above the current
546 If this directory is a
548 work tree, use the repository path associated with this work tree.
550 List all existing branches in the repository.
551 If invoked in a work tree, the work tree's current branch is shown
552 with one the following annotations:
553 .Bl -column YXZ description
554 .It * Ta work tree's base commit matches the branch tip
555 .It \(a~ Ta work tree's base commit is out-of-date
558 Delete the branch with the specified name from the repository.
559 Only the branch reference is deleted.
560 Any commit, tree, and blob objects belonging to the branch
561 remain in the repository and may be removed separately with
562 Git's garbage collector.
567 .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
568 Manage tags in a repository.
570 Tags are managed via references which live in the
575 command operates on references in this namespace only.
576 References in this namespace point at tag objects which contain a pointer
577 to another object, a tag message, as well as author and timestamp information.
579 Expect one or two arguments and attempt to create a tag with the given
581 and make this tag point at the given
583 If no commit is specified, default to the latest commit on the work tree's
584 current branch if invoked in a work tree, and to a commit resolved via
585 the repository's HEAD reference otherwise.
586 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
587 reference or tag name which will be resolved to a commit ID.
588 An abbreviated hash argument will be expanded to a full SHA1 hash
589 automatically, provided the abbreviation is unique.
596 Use the specified tag message when creating the new tag
601 opens a temporary file in an editor where a tag message can be written.
602 .It Fl r Ar repository-path
603 Use the repository at the specified path.
604 If not specified, assume the repository is located at or above the current
606 If this directory is a
608 work tree, use the repository path associated with this work tree.
610 List all existing tags in the repository instead of creating a new tag.
611 If this option is used, no other command-line arguments are allowed.
616 command will not delete tags or change existing tags.
617 If a tag must be deleted, the
619 command may be used to delete a tag's reference.
620 This should only be done if the tag has not already been copied to
622 .It Cm add Ar file-path ...
623 Schedule unversioned files in a work tree for addition to the
624 repository in the next commit.
625 .It Cm remove Ar file-path ...
626 Remove versioned files from a work tree and schedule them for deletion
627 from the repository in the next commit.
634 Perform the operation even if a file contains uncommitted modifications.
639 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
640 Revert any uncommitted changes in files at the specified paths.
641 File contents will be overwritten with those contained in the
642 work tree's base commit.
643 There is no way to bring discarded changes back after
646 If a file was added with
648 it will become an unversioned file again.
649 If a file was deleted with
658 Instead of reverting all changes in files, interactively select or reject
659 changes to revert based on
665 (quit reverting this file) responses.
666 If a file is in modified status, individual patches derived from the
667 modified file content can be reverted.
668 Files in added or deleted status may only be reverted in their entirety.
669 .It Fl F Ar response-script
677 responses line-by-line from the specified
679 file instead of prompting interactively.
681 Permit recursion into directories.
682 If this option is not specified,
684 will refuse to run if a specified
691 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
692 Create a new commit in the repository from changes in a work tree
693 and use this commit as the new base commit for the work tree.
696 is specified, commit all changes in the work tree.
697 Otherwise, commit changes at or within the specified paths.
699 If changes have been explicitly staged for commit with
701 only commit staged changes and reject any specified paths which
702 have not been staged.
704 Show the status of each affected file, using the following status codes:
705 .Bl -column YXZ description
706 .It M Ta modified file
707 .It D Ta file was deleted
708 .It A Ta new file was added
711 Files which are not part of the new commit will retain their previously
712 recorded base commit.
715 commands may refuse to run while the work tree contains files from
716 multiple base commits.
717 The base commit of such a work tree can be made consistent by running
719 across the entire work tree.
725 environment variable to be set,
730 configuration settings can be
731 obtained from the repository's
733 file or from Git's global
742 Use the specified log message when creating the new commit.
747 opens a temporary file in an editor where a log message can be written.
751 will refuse to run if certain preconditions are not met.
752 If the work tree's current branch is not in the
754 reference namespace, new commits may not be created on this branch.
755 Local changes may only be committed if they are based on file content
756 found in the most recent commit on the work tree's branch.
757 If a path is found to be out of date,
759 must be used first in order to merge local changes with changes made
764 .It Cm cherrypick Ar commit
765 Merge changes from a single
770 must be on a different branch than the work tree's base commit.
771 The expected argument is a reference or a commit ID SHA1 hash.
772 An abbreviated hash argument will be expanded to a full SHA1 hash
773 automatically, provided the abbreviation is unique.
775 Show the status of each affected file, using the following status codes:
776 .Bl -column YXZ description
777 .It G Ta file was merged
778 .It C Ta file was merged and conflicts occurred during merge
779 .It ! Ta changes destined for a missing file were not merged
780 .It D Ta file was deleted
781 .It d Ta file's deletion was obstructed by local modifications
782 .It A Ta new file was added
783 .It \(a~ Ta changes destined for a non-regular file were not merged
786 The merged changes will appear as local changes in the work tree, which
789 amended manually or with further
794 or discarded again with
798 will refuse to run if certain preconditions are not met.
799 If the work tree contains multiple base commits it must first be updated
800 to a single base commit with
802 If the work tree already contains files with merge conflicts, these
803 conflicts must be resolved first.
807 .It Cm backout Ar commit
808 Reverse-merge changes from a single
813 must be on the same branch as the work tree's base commit.
814 The expected argument is a reference or a commit ID SHA1 hash.
815 An abbreviated hash argument will be expanded to a full SHA1 hash
816 automatically, provided the abbreviation is unique.
818 Show the status of each affected file, using the following status codes:
819 .Bl -column YXZ description
820 .It G Ta file was merged
821 .It C Ta file was merged and conflicts occurred during merge
822 .It ! Ta changes destined for a missing file were not merged
823 .It D Ta file was deleted
824 .It d Ta file's deletion was obstructed by local modifications
825 .It A Ta new file was added
826 .It \(a~ Ta changes destined for a non-regular file were not merged
829 The reverse-merged changes will appear as local changes in the work tree,
830 which may be viewed with
832 amended manually or with further
837 or discarded again with
841 will refuse to run if certain preconditions are not met.
842 If the work tree contains multiple base commits it must first be updated
843 to a single base commit with
845 If the work tree already contains files with merge conflicts, these
846 conflicts must be resolved first.
850 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
851 Rebase commits on the specified
853 onto the tip of the current branch of the work tree.
856 must share common ancestry with the work tree's current branch.
857 Rebasing begins with the first descendant commit of the youngest
858 common ancestor commit shared by the specified
860 and the work tree's current branch, and stops once the tip commit
865 Rebased commits are accumulated on a temporary branch which the work tree
866 will remain switched to throughout the entire rebase operation.
867 Commits on this branch represent the same changes with the same log
868 messages as their counterparts on the original
870 but with different commit IDs.
871 Once rebasing has completed successfully, the temporary branch becomes
872 the new version of the specified
874 and the work tree is automatically switched to it.
876 While rebasing commits, show the status of each affected file,
877 using the following status codes:
878 .Bl -column YXZ description
879 .It G Ta file was merged
880 .It C Ta file was merged and conflicts occurred during merge
881 .It ! Ta changes destined for a missing file were not merged
882 .It D Ta file was deleted
883 .It d Ta file's deletion was obstructed by local modifications
884 .It A Ta new file was added
885 .It \(a~ Ta changes destined for a non-regular file were not merged
888 If merge conflicts occur the rebase operation is interrupted and may
889 be continued once conflicts have been resolved.
890 Alternatively, the rebase operation may be aborted which will leave
892 unmodified and the work tree switched back to its original branch.
894 If a merge conflict is resolved in a way which renders the merged
895 change into a no-op change, the corresponding commit will be elided
896 when the rebase operation continues.
899 will refuse to run if certain preconditions are not met.
900 If the work tree contains multiple base commits it must first be updated
901 to a single base commit with
903 If changes have been staged with
905 these changes must first be committed with
909 If the work tree contains local changes, these changes must first be
916 contains changes to files outside of the work tree's path prefix,
917 the work tree cannot be used to rebase this branch.
923 commands will refuse to run while a rebase operation is in progress.
924 Other commands which manipulate the work tree may be used for
925 conflict resolution purposes.
932 Abort an interrupted rebase operation.
933 If this option is used, no other command-line arguments are allowed.
935 Continue an interrupted rebase operation.
936 If this option is used, no other command-line arguments are allowed.
941 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
942 Edit commit history between the work tree's current base commit and
943 the tip commit of the work tree's current branch.
945 Editing of commit history is controlled via a
947 which can be edited interactively or passed on the command line.
948 The format of the histedit script is line-based.
949 Each line in the script begins with a command name, followed by
950 whitespace and an argument.
951 For most commands, the expected argument is a commit ID SHA1 hash.
952 Any remaining text on the line is ignored.
953 Lines which begin with the
955 character are ignored entirely.
957 The available commands are as follows:
958 .Bl -column YXZ pick-commit
959 .It pick Ar commit Ta Use the specified commit as it is.
960 .It edit Ar commit Ta Use the specified commit but once changes have been
961 merged into the work tree interrupt the histedit operation for amending.
962 .It fold Ar commit Ta Combine the specified commit with the next commit
963 listed further below that will be used.
964 .It drop Ar commit Ta Remove this commit from the edited history.
965 .It mesg Ar log-message Ta Use the specified single-line log message for
966 the commit on the previous line.
967 If the log message argument is left empty, open an editor where a new
968 log message can be written.
971 Every commit in the history being edited must be mentioned in the script.
972 Lines may be re-ordered to change the order of commits in the edited history.
974 Edited commits are accumulated on a temporary branch which the work tree
975 will remain switched to throughout the entire histedit operation.
976 Once history editing has completed successfully, the temporary branch becomes
977 the new version of the work tree's branch and the work tree is automatically
980 While merging commits, show the status of each affected file,
981 using the following status codes:
982 .Bl -column YXZ description
983 .It G Ta file was merged
984 .It C Ta file was merged and conflicts occurred during merge
985 .It ! Ta changes destined for a missing file were not merged
986 .It D Ta file was deleted
987 .It d Ta file's deletion was obstructed by local modifications
988 .It A Ta new file was added
989 .It \(a~ Ta changes destined for a non-regular file were not merged
992 If merge conflicts occur the histedit operation is interrupted and may
993 be continued once conflicts have been resolved.
994 Alternatively, the histedit operation may be aborted which will leave
995 the work tree switched back to its original branch.
997 If a merge conflict is resolved in a way which renders the merged
998 change into a no-op change, the corresponding commit will be elided
999 when the histedit operation continues.
1002 will refuse to run if certain preconditions are not met.
1003 If the work tree's current branch is not in the
1005 reference namespace, the history of the branch may not be edited.
1006 If the work tree contains multiple base commits it must first be updated
1007 to a single base commit with
1009 If changes have been staged with
1011 these changes must first be committed with
1015 If the work tree contains local changes, these changes must first be
1020 If the edited history contains changes to files outside of the work tree's
1021 path prefix, the work tree cannot be used to edit the history of this branch.
1025 command will refuse to run while a histedit operation is in progress.
1026 Other commands which manipulate the work tree may be used, and the
1028 command may be used to commit arbitrary changes to the temporary branch
1029 while the histedit operation is interrupted.
1036 Abort an interrupted histedit operation.
1037 If this option is used, no other command-line arguments are allowed.
1039 Continue an interrupted histedit operation.
1040 If this option is used, no other command-line arguments are allowed.
1045 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1046 Stage local changes for inclusion in the next commit.
1049 is specified, stage all changes in the work tree.
1050 Otherwise, stage changes at or within the specified paths.
1051 Paths may be staged if they are added, modified, or deleted according to
1054 Show the status of each affected file, using the following status codes:
1055 .Bl -column YXZ description
1056 .It A Ta file addition has been staged
1057 .It M Ta file modification has been staged
1058 .It D Ta file deletion has been staged
1061 Staged file contents are saved in newly created blob objects in the repository.
1062 These blobs will be referred to by tree objects once staged changes have been
1065 Staged changes affect the behaviour of
1070 While paths with staged changes exist, the
1072 command will refuse to commit any paths which do not have staged changes.
1073 Local changes created on top of staged changes can only be committed if
1074 the path is staged again, or if the staged changes are committed first.
1077 command will show both local changes and staged changes.
1080 command is able to display local changes relative to staged changes,
1081 and to display staged changes relative to the repository.
1084 command cannot revert staged changes but may be used to revert
1085 local changes created on top of staged changes.
1092 Instead of staging new changes, list paths which are already staged,
1093 along with the IDs of staged blob objects and stage status codes.
1094 If paths were provided in the command line show the staged paths
1095 among the specified paths.
1096 Otherwise, show all staged paths.
1098 Instead of staging the entire content of a changed file, interactively
1099 select or reject changes for staging based on
1103 (reject change), and
1105 (quit staging this file) responses.
1106 If a file is in modified status, individual patches derived from the
1107 modified file content can be staged.
1108 Files in added or deleted status may only be staged or rejected in
1110 .It Fl F Ar response-script
1118 responses line-by-line from the specified
1120 file instead of prompting interactively.
1124 will refuse to run if certain preconditions are not met.
1125 If a file contains merge conflicts, these conflicts must be resolved first.
1126 If a file is found to be out of date relative to the head commit on the
1127 work tree's current branch, the file must be updated with
1129 before it can be staged (however, this does not prevent the file from
1130 becoming out-of-date at some point after having been staged).
1137 commands will refuse to run while staged changes exist.
1138 If staged changes cannot be committed because a staged path
1139 is out of date, the path must be unstaged with
1141 before it can be updated with
1143 and may then be staged again if necessary.
1147 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1148 Merge staged changes back into the work tree and put affected paths
1149 back into non-staged status.
1152 is specified, unstage all staged changes across the entire work tree.
1153 Otherwise, unstage changes at or within the specified paths.
1155 Show the status of each affected file, using the following status codes:
1156 .Bl -column YXZ description
1157 .It G Ta file was unstaged
1158 .It C Ta file was unstaged and conflicts occurred during merge
1159 .It ! Ta changes destined for a missing file were not merged
1160 .It D Ta file was staged as deleted and still is deleted
1161 .It d Ta file's deletion was obstructed by local modifications
1162 .It \(a~ Ta changes destined for a non-regular file were not merged
1170 Instead of unstaging the entire content of a changed file, interactively
1171 select or reject changes for unstaging based on
1175 (keep change staged), and
1177 (quit unstaging this file) responses.
1178 If a file is staged in modified status, individual patches derived from the
1179 staged file content can be unstaged.
1180 Files staged in added or deleted status may only be unstaged in their entirety.
1181 .It Fl F Ar response-script
1189 responses line-by-line from the specified
1191 file instead of prompting interactively.
1196 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1197 Parse and print contents of objects to standard output in a line-based
1199 Content of commit, tree, and tag objects is printed in a way similar
1200 to the actual content stored in such objects.
1201 Blob object contents are printed as they would appear in files on disk.
1203 Attempt to interpret each argument as a reference, a tag name, or
1204 an object ID SHA1 hash.
1205 References will be resolved to an object ID.
1206 Tag names will resolved to a tag object.
1207 An abbreviated hash argument will be expanded to a full SHA1 hash
1208 automatically, provided the abbreviation is unique.
1210 If none of the above interpretations produce a valid result, or if the
1212 option is used, attempt to interpret the argument as a path which will
1213 be resolved to the ID of an object found at this path in the repository.
1220 Look up paths in the specified
1222 If this option is not used, paths are looked up in the commit resolved
1223 via the repository's HEAD reference.
1224 The expected argument is a commit ID SHA1 hash or an existing reference
1225 or tag name which will be resolved to a commit ID.
1226 An abbreviated hash argument will be expanded to a full SHA1 hash
1227 automatically, provided the abbreviation is unique.
1228 .It Fl r Ar repository-path
1229 Use the repository at the specified path.
1230 If not specified, assume the repository is located at or above the current
1232 If this directory is a
1234 work tree, use the repository path associated with this work tree.
1236 Interpret all arguments as paths only.
1237 This option can be used to resolve ambiguity in cases where paths
1238 look like tag names, reference names, or object IDs.
1242 .Bl -tag -width GOT_AUTHOR
1244 The author's name and email address for
1249 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1252 may fail to parse commits without an email address in author data,
1256 environment variables with a missing email address.
1262 configuration settings in the repository's
1264 file will override the value of
1270 configuration settings contained in Git's global
1272 configuration file will be used only if the
1274 environment variable is
1277 .It Ev VISUAL , EDITOR
1278 The editor spawned by
1283 .It Ev GOT_LOG_DEFAULT_LIMIT
1284 The default limit on the number of commits traversed by
1286 If set to zero, the limit is unbounded.
1287 This variable will be silently ignored if it is set to a non-numeric value.
1292 Clone an existing Git repository for use with
1294 This step currently requires
1298 .Dl $ git clone --bare https://github.com/openbsd/src.git
1300 Alternatively, for quick and dirty local testing of
1302 a new Git repository could be created and populated with files,
1303 e.g. from a temporary CVS checkout located at
1306 .Dl $ got init /var/git/src.git
1307 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1309 Check out a work tree from the Git repository to /usr/src:
1311 .Dl $ got checkout /var/git/src.git /usr/src
1313 View local changes in a work tree directory:
1316 .Dl $ got diff | less
1318 Interactively revert selected local changes in a work tree directory:
1320 .Dl $ got revert -p -R\ .
1322 In a work tree or a git repository directory, list all branch references:
1326 In a work tree or a git repository directory, create a new branch called
1327 .Dq unified-buffer-cache
1328 which is forked off the
1332 .Dl $ got branch unified-buffer-cache master
1334 Switch an existing work tree to the branch
1335 .Dq unified-buffer-cache .
1336 Local changes in the work tree will be preserved and merged if necessary:
1338 .Dl $ got update -b unified-buffer-cache
1340 Create a new commit from local changes in a work tree directory.
1341 This new commit will become the head commit of the work tree's current branch:
1345 In a work tree or a git repository directory, view changes committed in
1346 the 3 most recent commits to the work tree's branch, or the branch resolved
1347 via the repository's HEAD reference, respectively:
1349 .Dl $ got log -p -l 3 -f
1351 Add new files and remove obsolete files in a work tree directory:
1353 .Dl $ got add sys/uvm/uvm_ubc.c
1354 .Dl $ got remove sys/uvm/uvm_vnode.c
1356 Create a new commit from local changes in a work tree directory
1357 with a pre-defined log message.
1359 .Dl $ got commit -m 'unify the buffer cache'
1361 Update any work tree checked out from the
1362 .Dq unified-buffer-cache
1363 branch to the latest commit on this branch:
1367 Roll file content on the unified-buffer-cache branch back by one commit,
1368 and then fetch the rolled-back change into the work tree as a local change
1369 to be amended and perhaps committed again:
1371 .Dl $ got backout unified-buffer-cache
1372 .Dl $ got commit -m 'roll back previous'
1373 .Dl $ # now back out the previous backout :-)
1374 .Dl $ got backout unified-buffer-cache
1376 Fetch new upstream commits into the local repository's master branch.
1377 This step currently requires
1380 .Dl $ cd /var/git/src.git
1381 .Dl $ git fetch origin master:master
1384 .Dq unified-buffer-cache
1385 branch on top of the new head commit of the
1389 .Dl $ got update -b master
1390 .Dl $ got rebase unified-buffer-cache
1392 Create a patch from all changes on the unified-buffer-cache branch.
1393 The patch can be mailed out for review and applied to
1397 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1399 Edit the entire commit history of the
1400 .Dq unified-buffer-cache
1403 .Dl $ got update -b unified-buffer-cache
1404 .Dl $ got update -c master
1407 Additional steps are necessary if local changes need to be pushed back
1408 to the remote repository, which currently requires
1412 Before working against existing branches in a repository cloned with
1413 .Dq git clone --bare ,
1416 must be configured to map all references in the remote repository
1419 namespace of the local repository.
1420 This can achieved by setting Git's
1421 .Pa remote.origin.fetch
1422 configuration variable to the value
1423 .Dq +refs/heads/*:refs/remotes/origin/*
1428 .Dl $ cd /var/git/repo
1429 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1431 Alternatively, the following
1433 configuration item can be added manually to the Git repository's
1437 .Dl [remote "origin"]
1439 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1441 This configuration leaves the local repository's
1443 namespace free for use by local branches checked out with
1445 and, if needed, created with
1450 namespace can be updated with incoming changes from the remote
1454 .Dl $ cd /var/git/repo
1457 Before outgoing changes on the local
1459 branch can be pushed to the remote repository, the local
1461 branch must be rebased onto the
1465 .Dl $ got update -b origin/master
1466 .Dl $ got rebase master
1468 Changes on the local
1470 branch can then be pushed to the remote
1474 .Dl $ cd /var/git/repo
1475 .Dl $ git push origin master
1478 .Xr git-repository 5 ,
1481 .An Stefan Sperling Aq Mt stsp@openbsd.org
1482 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1483 .An Joshua Stein Aq Mt jcs@openbsd.org
1486 is a work-in-progress and many commands remain to be implemented.
1487 At present, the user has to fall back on
1489 to perform many tasks, in particular tasks related to repository
1490 administration and tasks which require a network connection.
