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,
97 .Dv user.email configuration settings can be
98 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
286 files in each traversed directory and will not display unversioned files
289 ignore patterns contained in
295 only supports a single ignore pattern per line.
299 .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
300 Display history of a repository.
303 is specified, show only commits which modified this path.
310 Start traversing history at the specified
312 The expected argument is a commit ID SHA1 hash or an existing reference
313 or tag name which will be resolved to a commit ID.
314 An abbreviated hash argument will be expanded to a full SHA1 hash
315 automatically, provided the abbreviation is unique.
316 If this option is not specified, default to the work tree's current branch
317 if invoked in a work tree, or to the repository's HEAD reference.
319 Set the number of context lines shown in diffs with
321 By default, 3 lines of context are shown.
323 Restrict history traversal to the first parent of each commit.
324 This shows the linear history of the current branch only.
325 Merge commits which affected the current branch will be shown but
326 individual commits which originated on other branches will be omitted.
328 Limit history traversal to a given number of commits.
329 If this option is not specified, a default limit value of zero is used,
330 which is treated as an unbounded limit.
332 .Ev GOT_LOG_DEFAULT_LIMIT
333 environment variable may be set to change this default value.
335 Display the patch of modifications made in each commit.
338 is specified, only show the patch of modifications at or within this path.
339 .It Fl r Ar repository-path
340 Use the repository at the specified path.
341 If not specified, assume the repository is located at or above the current
343 If this directory is a
345 work tree, use the repository path associated with this work tree.
347 .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
348 When invoked within a work tree with less than two arguments, display
349 uncommitted changes in the work tree.
352 is specified, only show changes within this path.
354 If two arguments are provided, treat each argument as a reference, a tag
355 name, or an object ID SHA1 hash, and display differences between the
356 corresponding objects.
357 Both objects must be of the same type (blobs, trees, or commits).
358 An abbreviated hash argument will be expanded to a full SHA1 hash
359 automatically, provided the abbreviation is unique.
366 Set the number of context lines shown in the diff.
367 By default, 3 lines of context are shown.
368 .It Fl r Ar repository-path
369 Use the repository at the specified path.
370 If not specified, assume the repository is located at or above the current
372 If this directory is a
374 work tree, use the repository path associated with this work tree.
376 Show changes staged with
378 instead of showing local changes.
379 This option is only valid when
381 is invoked in a work tree.
386 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
387 Display line-by-line history of a file at the specified path.
394 Start traversing history at the specified
396 The expected argument is a commit ID SHA1 hash or an existing reference
397 or tag name which will be resolved to a commit ID.
398 An abbreviated hash argument will be expanded to a full SHA1 hash
399 automatically, provided the abbreviation is unique.
400 .It Fl r Ar repository-path
401 Use the repository at the specified path.
402 If not specified, assume the repository is located at or above the current
404 If this directory is a
406 work tree, use the repository path associated with this work tree.
411 .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
412 Display a listing of files and directories at the specified
413 directory path in the repository.
414 Entries shown in this listing may carry one of the following trailing
416 .Bl -column YXZ description
417 .It @ Ta entry is a symbolic link
418 .It / Ta entry is a directory
419 .It * Ta entry is an executable file
420 .It $ Ta entry is a Git submodule
425 is specified, list the repository path corresponding to the current
426 directory of the work tree, or the root directory of the repository
427 if there is no work tree.
434 List files and directories as they appear in the specified
436 The expected argument is a commit ID SHA1 hash or an existing reference
437 or tag name which will be resolved to a commit ID.
438 An abbreviated hash argument will be expanded to a full SHA1 hash
439 automatically, provided the abbreviation is unique.
440 .It Fl r Ar repository-path
441 Use the repository at the specified path.
442 If not specified, assume the repository is located at or above the current
444 If this directory is a
446 work tree, use the repository path associated with this work tree.
448 Show object IDs of files (blob objects) and directories (tree objects).
450 Recurse into sub-directories in the repository.
455 .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
456 Manage references in a repository.
458 If no options are passed, expect two arguments and attempt to create,
459 or update, the reference with the given
461 and make it point at the given
463 The target may be an object ID SHA1 hash or an existing reference which
464 will be resolved to an object ID.
465 An abbreviated hash argument will be expanded to a full SHA1 hash
466 automatically, provided the abbreviation is unique.
472 .It Fl r Ar repository-path
473 Use the repository at the specified path.
474 If not specified, assume the repository is located at or above the current
476 If this directory is a
478 work tree, use the repository path associated with this work tree.
480 List all existing references in the repository.
482 Delete the reference with the specified name from the repository.
484 Create a symbolic reference pointing at the specified
486 which must be an existing reference.
487 Care should be taken not to create loops between references when
490 .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
491 Manage branches in a repository.
493 Branches are managed via references which live in the
498 command operates on references in this namespace only.
500 If no options are passed, expect one or two arguments and attempt to create
501 a branch reference with the given
503 and make it point at the given
507 argument is a commit ID SHA1 hash or an existing reference
508 or tag name which will be resolved to a commit ID.
511 is specified, default to the latest commit on the work tree's current
512 branch if invoked in a work tree, or to a commit resolved via the
513 repository's HEAD reference.
519 .It Fl r Ar repository-path
520 Use the repository at the specified path.
521 If not specified, assume the repository is located at or above the current
523 If this directory is a
525 work tree, use the repository path associated with this work tree.
527 List all existing branches in the repository.
528 If invoked in a work tree, the work tree's current branch is shown
529 with one the following annotations:
530 .Bl -column YXZ description
531 .It * Ta work tree's base commit matches the branch tip
532 .It \(a~ Ta work tree's base commit is out-of-date
535 Delete the branch with the specified name from the repository.
536 Only the branch reference is deleted.
537 Any commit, tree, and blob objects belonging to the branch
538 remain in the repository and may be removed separately with
539 Git's garbage collector.
544 .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
545 Manage tags in a repository.
547 Tags are managed via references which live in the
552 command operates on references in this namespace only.
553 References in this namespace point at tag objects which contain a pointer
554 to another object, a tag message, as well as author and timestamp information.
556 Expect one or two arguments and attempt to create a tag with the given
558 and make this tag point at the given
560 If no commit is specified, default to the latest commit on the work tree's
561 current branch if invoked in a work tree, and to a commit resolved via
562 the repository's HEAD reference otherwise.
563 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
564 reference or tag name which will be resolved to a commit ID.
565 An abbreviated hash argument will be expanded to a full SHA1 hash
566 automatically, provided the abbreviation is unique.
573 Use the specified tag message when creating the new tag
578 opens a temporary file in an editor where a tag message can be written.
579 .It Fl r Ar repository-path
580 Use the repository at the specified path.
581 If not specified, assume the repository is located at or above the current
583 If this directory is a
585 work tree, use the repository path associated with this work tree.
587 List all existing tags in the repository instead of creating a new tag.
588 If this option is used, no other command-line arguments are allowed.
593 command will not delete tags or change existing tags.
594 If a tag must be deleted, the
596 command may be used to delete a tag's reference.
597 This should only be done if the tag has not already been copied to
599 .It Cm add Ar file-path ...
600 Schedule unversioned files in a work tree for addition to the
601 repository in the next commit.
602 .It Cm remove Ar file-path ...
603 Remove versioned files from a work tree and schedule them for deletion
604 from the repository in the next commit.
611 Perform the operation even if a file contains uncommitted modifications.
616 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
617 Revert any uncommitted changes in files at the specified paths.
618 File contents will be overwritten with those contained in the
619 work tree's base commit.
620 There is no way to bring discarded changes back after
623 If a file was added with
625 it will become an unversioned file again.
626 If a file was deleted with
635 Instead of reverting all changes in files, interactively select or reject
636 changes to revert based on
642 (quit reverting this file) responses.
643 If a file is in modified status, individual patches derived from the
644 modified file content can be reverted.
645 Files in added or deleted status may only be reverted in their entirety.
646 .It Fl F Ar response-script
654 responses line-by-line from the specified
656 file instead of prompting interactively.
658 Permit recursion into directories.
659 If this option is not specified,
661 will refuse to run if a specified
668 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
669 Create a new commit in the repository from changes in a work tree
670 and use this commit as the new base commit for the work tree.
673 is specified, commit all changes in the work tree.
674 Otherwise, commit changes at or within the specified paths.
676 If changes have been explicitly staged for commit with
678 only commit staged changes and reject any specified paths which
679 have not been staged.
681 Show the status of each affected file, using the following status codes:
682 .Bl -column YXZ description
683 .It M Ta modified file
684 .It D Ta file was deleted
685 .It A Ta new file was added
688 Files which are not part of the new commit will retain their previously
689 recorded base commit.
692 commands may refuse to run while the work tree contains files from
693 multiple base commits.
694 The base commit of such a work tree can be made consistent by running
696 across the entire work tree.
702 environment variable to be set,
706 .Dv user.email configuration settings can be
707 obtained from the repository's
709 file or from Git's global
718 Use the specified log message when creating the new commit.
723 opens a temporary file in an editor where a log message can be written.
727 will refuse to run if certain preconditions are not met.
728 If the work tree's current branch is not in the
730 reference namespace, new commits may not be created on this branch.
731 Local changes may only be committed if they are based on file content
732 found in the most recent commit on the work tree's branch.
733 If a path is found to be out of date,
735 must be used first in order to merge local changes with changes made
740 .It Cm cherrypick Ar commit
741 Merge changes from a single
746 must be on a different branch than the work tree's base commit.
747 The expected argument is a reference or a commit ID SHA1 hash.
748 An abbreviated hash argument will be expanded to a full SHA1 hash
749 automatically, provided the abbreviation is unique.
751 Show the status of each affected file, using the following status codes:
752 .Bl -column YXZ description
753 .It G Ta file was merged
754 .It C Ta file was merged and conflicts occurred during merge
755 .It ! Ta changes destined for a missing file were not merged
756 .It D Ta file was deleted
757 .It d Ta file's deletion was obstructed by local modifications
758 .It A Ta new file was added
759 .It \(a~ Ta changes destined for a non-regular file were not merged
762 The merged changes will appear as local changes in the work tree, which
765 amended manually or with further
770 or discarded again with
774 will refuse to run if certain preconditions are not met.
775 If the work tree contains multiple base commits it must first be updated
776 to a single base commit with
778 If the work tree already contains files with merge conflicts, these
779 conflicts must be resolved first.
783 .It Cm backout Ar commit
784 Reverse-merge changes from a single
789 must be on the same branch as the work tree's base commit.
790 The expected argument is a reference or a commit ID SHA1 hash.
791 An abbreviated hash argument will be expanded to a full SHA1 hash
792 automatically, provided the abbreviation is unique.
794 Show the status of each affected file, using the following status codes:
795 .Bl -column YXZ description
796 .It G Ta file was merged
797 .It C Ta file was merged and conflicts occurred during merge
798 .It ! Ta changes destined for a missing file were not merged
799 .It D Ta file was deleted
800 .It d Ta file's deletion was obstructed by local modifications
801 .It A Ta new file was added
802 .It \(a~ Ta changes destined for a non-regular file were not merged
805 The reverse-merged changes will appear as local changes in the work tree,
806 which may be viewed with
808 amended manually or with further
813 or discarded again with
817 will refuse to run if certain preconditions are not met.
818 If the work tree contains multiple base commits it must first be updated
819 to a single base commit with
821 If the work tree already contains files with merge conflicts, these
822 conflicts must be resolved first.
826 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
827 Rebase commits on the specified
829 onto the tip of the current branch of the work tree.
832 must share common ancestry with the work tree's current branch.
833 Rebasing begins with the first descendant commit of the youngest
834 common ancestor commit shared by the specified
836 and the work tree's current branch, and stops once the tip commit
841 Rebased commits are accumulated on a temporary branch which the work tree
842 will remain switched to throughout the entire rebase operation.
843 Commits on this branch represent the same changes with the same log
844 messages as their counterparts on the original
846 but with different commit IDs.
847 Once rebasing has completed successfully, the temporary branch becomes
848 the new version of the specified
850 and the work tree is automatically switched to it.
852 While rebasing commits, show the status of each affected file,
853 using the following status codes:
854 .Bl -column YXZ description
855 .It G Ta file was merged
856 .It C Ta file was merged and conflicts occurred during merge
857 .It ! Ta changes destined for a missing file were not merged
858 .It D Ta file was deleted
859 .It d Ta file's deletion was obstructed by local modifications
860 .It A Ta new file was added
861 .It \(a~ Ta changes destined for a non-regular file were not merged
864 If merge conflicts occur the rebase operation is interrupted and may
865 be continued once conflicts have been resolved.
866 Alternatively, the rebase operation may be aborted which will leave
868 unmodified and the work tree switched back to its original branch.
870 If a merge conflict is resolved in a way which renders the merged
871 change into a no-op change, the corresponding commit will be elided
872 when the rebase operation continues.
875 will refuse to run if certain preconditions are not met.
876 If the work tree contains multiple base commits it must first be updated
877 to a single base commit with
879 If changes have been staged with
881 these changes must first be committed with
885 If the work tree contains local changes, these changes must first be
892 contains changes to files outside of the work tree's path prefix,
893 the work tree cannot be used to rebase this branch.
899 commands will refuse to run while a rebase operation is in progress.
900 Other commands which manipulate the work tree may be used for
901 conflict resolution purposes.
908 Abort an interrupted rebase operation.
909 If this option is used, no other command-line arguments are allowed.
911 Continue an interrupted rebase operation.
912 If this option is used, no other command-line arguments are allowed.
917 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
918 Edit commit history between the work tree's current base commit and
919 the tip commit of the work tree's current branch.
921 Editing of commit history is controlled via a
923 which can be edited interactively or passed on the command line.
924 The format of the histedit script is line-based.
925 Each line in the script begins with a command name, followed by
926 whitespace and an argument.
927 For most commands, the expected argument is a commit ID SHA1 hash.
928 Any remaining text on the line is ignored.
929 Lines which begin with the
931 character are ignored entirely.
933 The available commands are as follows:
934 .Bl -column YXZ pick-commit
935 .It pick Ar commit Ta Use the specified commit as it is.
936 .It edit Ar commit Ta Use the specified commit but once changes have been
937 merged into the work tree interrupt the histedit operation for amending.
938 .It fold Ar commit Ta Combine the specified commit with the next commit
939 listed further below that will be used.
940 .It drop Ar commit Ta Remove this commit from the edited history.
941 .It mesg Ar log-message Ta Use the specified single-line log message for
942 the commit on the previous line.
943 If the log message argument is left empty, open an editor where a new
944 log message can be written.
947 Every commit in the history being edited must be mentioned in the script.
948 Lines may be re-ordered to change the order of commits in the edited history.
950 Edited commits are accumulated on a temporary branch which the work tree
951 will remain switched to throughout the entire histedit operation.
952 Once history editing has completed successfully, the temporary branch becomes
953 the new version of the work tree's branch and the work tree is automatically
956 While merging commits, show the status of each affected file,
957 using the following status codes:
958 .Bl -column YXZ description
959 .It G Ta file was merged
960 .It C Ta file was merged and conflicts occurred during merge
961 .It ! Ta changes destined for a missing file were not merged
962 .It D Ta file was deleted
963 .It d Ta file's deletion was obstructed by local modifications
964 .It A Ta new file was added
965 .It \(a~ Ta changes destined for a non-regular file were not merged
968 If merge conflicts occur the histedit operation is interrupted and may
969 be continued once conflicts have been resolved.
970 Alternatively, the histedit operation may be aborted which will leave
971 the work tree switched back to its original branch.
973 If a merge conflict is resolved in a way which renders the merged
974 change into a no-op change, the corresponding commit will be elided
975 when the histedit operation continues.
978 will refuse to run if certain preconditions are not met.
979 If the work tree's current branch is not in the
981 reference namespace, the history of the branch may not be edited.
982 If the work tree contains multiple base commits it must first be updated
983 to a single base commit with
985 If changes have been staged with
987 these changes must first be committed with
991 If the work tree contains local changes, these changes must first be
996 If the edited history contains changes to files outside of the work tree's
997 path prefix, the work tree cannot be used to edit the history of this branch.
1001 command will refuse to run while a histedit operation is in progress.
1002 Other commands which manipulate the work tree may be used, and the
1004 command may be used to commit arbitrary changes to the temporary branch
1005 while the histedit operation is interrupted.
1012 Abort an interrupted histedit operation.
1013 If this option is used, no other command-line arguments are allowed.
1015 Continue an interrupted histedit operation.
1016 If this option is used, no other command-line arguments are allowed.
1021 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1022 Stage local changes for inclusion in the next commit.
1025 is specified, stage all changes in the work tree.
1026 Otherwise, stage changes at or within the specified paths.
1027 Paths may be staged if they are added, modified, or deleted according to
1030 Show the status of each affected file, using the following status codes:
1031 .Bl -column YXZ description
1032 .It A Ta file addition has been staged
1033 .It M Ta file modification has been staged
1034 .It D Ta file deletion has been staged
1037 Staged file contents are saved in newly created blob objects in the repository.
1038 These blobs will be referred to by tree objects once staged changes have been
1041 Staged changes affect the behaviour of
1046 While paths with staged changes exist, the
1048 command will refuse to commit any paths which do not have staged changes.
1049 Local changes created on top of staged changes can only be committed if
1050 the path is staged again, or if the staged changes are committed first.
1053 command will show both local changes and staged changes.
1056 command is able to display local changes relative to staged changes,
1057 and to display staged changes relative to the repository.
1060 command cannot revert staged changes but may be used to revert
1061 local changes created on top of staged changes.
1068 Instead of staging new changes, list paths which are already staged,
1069 along with the IDs of staged blob objects and stage status codes.
1070 If paths were provided in the command line show the staged paths
1071 among the specified paths.
1072 Otherwise, show all staged paths.
1074 Instead of staging the entire content of a changed file, interactively
1075 select or reject changes for staging based on
1079 (reject change), and
1081 (quit staging this file) responses.
1082 If a file is in modified status, individual patches derived from the
1083 modified file content can be staged.
1084 Files in added or deleted status may only be staged or rejected in
1086 .It Fl F Ar response-script
1094 responses line-by-line from the specified
1096 file instead of prompting interactively.
1100 will refuse to run if certain preconditions are not met.
1101 If a file contains merge conflicts, these conflicts must be resolved first.
1102 If a file is found to be out of date relative to the head commit on the
1103 work tree's current branch, the file must be updated with
1105 before it can be staged (however, this does not prevent the file from
1106 becoming out-of-date at some point after having been staged).
1113 commands will refuse to run while staged changes exist.
1114 If staged changes cannot be committed because a staged path
1115 is out of date, the path must be unstaged with
1117 before it can be updated with
1119 and may then be staged again if necessary.
1123 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1124 Merge staged changes back into the work tree and put affected paths
1125 back into non-staged status.
1128 is specified, unstage all staged changes across the entire work tree.
1129 Otherwise, unstage changes at or within the specified paths.
1131 Show the status of each affected file, using the following status codes:
1132 .Bl -column YXZ description
1133 .It G Ta file was unstaged
1134 .It C Ta file was unstaged and conflicts occurred during merge
1135 .It ! Ta changes destined for a missing file were not merged
1136 .It D Ta file was staged as deleted and still is deleted
1137 .It d Ta file's deletion was obstructed by local modifications
1138 .It \(a~ Ta changes destined for a non-regular file were not merged
1146 Instead of unstaging the entire content of a changed file, interactively
1147 select or reject changes for unstaging based on
1151 (keep change staged), and
1153 (quit unstaging this file) responses.
1154 If a file is staged in modified status, individual patches derived from the
1155 staged file content can be unstaged.
1156 Files staged in added or deleted status may only be unstaged in their entirety.
1157 .It Fl F Ar response-script
1165 responses line-by-line from the specified
1167 file instead of prompting interactively.
1172 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1173 Parse and print contents of objects to standard output in a line-based
1175 Content of commit, tree, and tag objects is printed in a way similar
1176 to the actual content stored in such objects.
1177 Blob object contents are printed as they would appear in files on disk.
1179 Attempt to interpret each argument as a reference, a tag name, or
1180 an object ID SHA1 hash.
1181 References will be resolved to an object ID.
1182 Tag names will resolved to a tag object.
1183 An abbreviated hash argument will be expanded to a full SHA1 hash
1184 automatically, provided the abbreviation is unique.
1186 If none of the above interpretations produce a valid result, or if the
1188 option is used, attempt to interpret the argument as a path which will
1189 be resolved to the ID of an object found at this path in the repository.
1196 Look up paths in the specified
1198 If this option is not used, paths are looked up in the commit resolved
1199 via the repository's HEAD reference.
1200 The expected argument is a commit ID SHA1 hash or an existing reference
1201 or tag name which will be resolved to a commit ID.
1202 An abbreviated hash argument will be expanded to a full SHA1 hash
1203 automatically, provided the abbreviation is unique.
1204 .It Fl r Ar repository-path
1205 Use the repository at the specified path.
1206 If not specified, assume the repository is located at or above the current
1208 If this directory is a
1210 work tree, use the repository path associated with this work tree.
1212 Interpret all arguments as paths only.
1213 This option can be used to resolve ambiguity in cases where paths
1214 look like tag names, reference names, or object IDs.
1218 .Bl -tag -width GOT_AUTHOR
1220 The author's name and email address for
1225 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1228 may fail to parse commits without an email address in author data,
1232 environment variables with a missing email address.
1237 .Dv user.email configuration settings in the repository's
1239 file will override the value of
1245 configuration settings contained in Git's global
1247 configuration file will be used only if the
1249 environment variable is
1252 .It Ev VISUAL , EDITOR
1253 The editor spawned by
1258 .It Ev GOT_LOG_DEFAULT_LIMIT
1259 The default limit on the number of commits traversed by
1261 If set to zero, the limit is unbounded.
1262 This variable will be silently ignored if it is set to a non-numeric value.
1267 Clone an existing Git repository for use with
1269 This step currently requires
1273 .Dl $ git clone --bare https://github.com/openbsd/src.git
1275 Alternatively, for quick and dirty local testing of
1277 a new Git repository could be created and populated with files,
1278 e.g. from a temporary CVS checkout located at
1281 .Dl $ got init /var/git/src.git
1282 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1284 Check out a work tree from the Git repository to /usr/src:
1286 .Dl $ got checkout /var/git/src.git /usr/src
1288 View local changes in a work tree directory:
1291 .Dl $ got diff | less
1293 Interactively revert selected local changes in a work tree directory:
1295 .Dl $ got revert -p -R\ .
1297 In a work tree or a git repository directory, list all branch references:
1301 In a work tree or a git repository directory, create a new branch called
1302 .Dq unified-buffer-cache
1303 which is forked off the
1307 .Dl $ got branch unified-buffer-cache master
1309 Switch an existing work tree to the branch
1310 .Dq unified-buffer-cache .
1311 Local changes in the work tree will be preserved and merged if necessary:
1313 .Dl $ got update -b unified-buffer-cache
1315 Create a new commit from local changes in a work tree directory.
1316 This new commit will become the head commit of the work tree's current branch:
1320 In a work tree or a git repository directory, view changes committed in
1321 the 3 most recent commits to the work tree's branch, or the branch resolved
1322 via the repository's HEAD reference, respectively:
1324 .Dl $ got log -p -l 3 -f
1326 Add new files and remove obsolete files in a work tree directory:
1328 .Dl $ got add sys/uvm/uvm_ubc.c
1329 .Dl $ got remove sys/uvm/uvm_vnode.c
1331 Create a new commit from local changes in a work tree directory
1332 with a pre-defined log message.
1334 .Dl $ got commit -m 'unify the buffer cache'
1336 Update any work tree checked out from the
1337 .Dq unified-buffer-cache
1338 branch to the latest commit on this branch:
1342 Roll file content on the unified-buffer-cache branch back by one commit,
1343 and then fetch the rolled-back change into the work tree as a local change
1344 to be amended and perhaps committed again:
1346 .Dl $ got backout unified-buffer-cache
1347 .Dl $ got commit -m 'roll back previous'
1348 .Dl $ # now back out the previous backout :-)
1349 .Dl $ got backout unified-buffer-cache
1351 Fetch new upstream commits into the local repository's master branch.
1352 This step currently requires
1355 .Dl $ cd /var/git/src.git
1356 .Dl $ git fetch origin master:master
1359 .Dq unified-buffer-cache
1360 branch on top of the new head commit of the
1364 .Dl $ got update -b master
1365 .Dl $ got rebase unified-buffer-cache
1367 Create a patch from all changes on the unified-buffer-cache branch.
1368 The patch can be mailed out for review and applied to
1372 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1374 Edit the entire commit history of the
1375 .Dq unified-buffer-cache
1378 .Dl $ got update -b unified-buffer-cache
1379 .Dl $ got update -c master
1382 Additional steps are necessary if local changes need to be pushed back
1383 to the remote repository, which currently requires
1387 Before working against existing branches in a repository cloned with
1388 .Dq git clone --bare ,
1391 must be configured to map all references in the remote repository
1394 namespace of the local repository.
1395 This can achieved by setting Git's
1396 .Pa remote.origin.fetch
1397 configuration variable to the value
1398 .Dq +refs/heads/*:refs/remotes/origin/*
1403 .Dl $ cd /var/git/repo
1404 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1406 Alternatively, the following
1408 configuration item can be added manually to the Git repository's
1412 .Dl [remote "origin"]
1414 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1416 This configuration leaves the local repository's
1418 namespace free for use by local branches checked out with
1420 and, if needed, created with
1425 namespace can be updated with incoming changes from the remote
1429 .Dl $ cd /var/git/repo
1432 Before outgoing changes on the local
1434 branch can be pushed to the remote repository, the local
1436 branch must be rebased onto the
1440 .Dl $ got update -b origin/master
1441 .Dl $ got rebase master
1443 Changes on the local
1445 branch can then be pushed to the remote
1449 .Dl $ cd /var/git/repo
1450 .Dl $ git push origin master
1453 .Xr git-repository 5 ,
1456 .An Stefan Sperling Aq Mt stsp@openbsd.org
1457 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1458 .An Joshua Stein Aq Mt jcs@openbsd.org
1461 is a work-in-progress and many commands remain to be implemented.
1462 At present, the user has to fall back on
1464 to perform many tasks, in particular tasks related to repository
1465 administration and tasks which require a network connection.
