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
109 instead of creating the default branch
111 Use of this option is required if the
113 branch already exists.
115 Use the specified log message when creating the new commit.
120 opens a temporary file in an editor where a log message can be written.
121 .It Fl r Ar repository-path
122 Use the repository at the specified path.
123 If not specified, assume the repository is located at or above the current
126 Ignore files or directories with a name which matches the specified
128 This option may be specified multiple times to build a list of ignore patterns.
131 follows the globbing rules documented in
137 .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
138 Copy files from a repository into a new work tree.
141 is not specified, either use the last component of
142 .Ar repository path ,
145 was specified use the last component of
153 Check out files from a commit on the specified
155 If this option is not specified, a branch resolved via the repository's HEAD
156 reference will be used.
158 Check out files from the specified
160 on the selected branch.
161 The expected argument is a commit ID SHA1 hash or an existing reference
162 or tag name which will be resolved to a commit ID.
163 An abbreviated hash argument will be expanded to a full SHA1 hash
164 automatically, provided the abbreviation is unique.
165 If this option is not specified, the most recent commit on the selected
167 .It Fl p Ar path-prefix
168 Restrict the work tree to a subset of the repository's tree hierarchy.
169 Only files beneath the specified
176 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
177 Update an existing work tree to a different commit.
178 Show the status of each affected file, using the following status codes:
179 .Bl -column YXZ description
180 .It U Ta file was updated and contained no local changes
181 .It G Ta file was updated and local changes were merged cleanly
182 .It C Ta file was updated and conflicts occurred during merge
183 .It D Ta file was deleted
184 .It A Ta new file was added
185 .It \(a~ Ta versioned file is obstructed by a non-regular file
186 .It ! Ta a missing versioned file was restored
191 is specified, update the entire work tree.
192 Otherwise, restrict the update operation to files at or within the
194 Each path is required to exist in the update operation's target commit.
195 Files in the work tree outside specified paths will remain unchanged and
196 will retain their previously recorded base commit.
199 commands may refuse to run while the work tree contains files from
200 multiple base commits.
201 The base commit of such a work tree can be made consistent by running
203 across the entire work tree.
206 is incompatible with the
211 cannot update paths with staged changes.
212 If changes have been staged with
214 these changes must first be committed with
224 Switch the work tree's branch reference to the specified
226 before updating the work tree.
227 This option requires that all paths in the work tree are updated.
229 Update the work tree to the specified
231 The expected argument is a commit ID SHA1 hash or an existing reference
232 or tag name which will be resolved to a commit ID.
233 An abbreviated hash argument will be expanded to a full SHA1 hash
234 automatically, provided the abbreviation is unique.
235 If this option is not specified, the most recent commit on the work tree's
241 .It Cm status Op Ar path ...
242 Show the current modification status of files in a work tree,
243 using the following status codes:
244 .Bl -column YXZ description
245 .It M Ta modified file
246 .It A Ta file scheduled for addition in next commit
247 .It D Ta file scheduled for deletion in next commit
248 .It C Ta modified or added file which contains merge conflicts
249 .It ! Ta versioned file was expected on disk but is missing
250 .It \(a~ Ta versioned file is obstructed by a non-regular file
251 .It ? Ta unversioned item not tracked by
253 .It N Ta non-existent
255 specified on the command line
260 is specified, show modifications in the entire work tree.
261 Otherwise, show modifications at or within the specified paths.
263 If changes have been staged with
265 staged changes are shown in the second output column, using the following
267 .Bl -column YXZ description
268 .It M Ta file modification is staged
269 .It A Ta file addition is staged
270 .It D Ta file deletion is staged
273 Changes created on top of staged changes are indicated in the first column:
274 .Bl -column YXZ description
275 .It MM Ta file was modified after earlier changes have been staged
276 .It MA Ta file was modified after having been staged for addition
279 For compatibility with
284 files in each traversed directory and will not display unversioned files
287 ignore patterns contained in
293 only supports a single ignore pattern per line.
297 .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
298 Display history of a repository.
301 is specified, show only commits which modified this path.
308 Start traversing history at the specified
310 The expected argument is a commit ID SHA1 hash or an existing reference
311 or tag name which will be resolved to a commit ID.
312 An abbreviated hash argument will be expanded to a full SHA1 hash
313 automatically, provided the abbreviation is unique.
314 If this option is not specified, default to the work tree's current branch
315 if invoked in a work tree, or to the repository's HEAD reference.
317 Set the number of context lines shown in diffs with
319 By default, 3 lines of context are shown.
321 Restrict history traversal to the first parent of each commit.
322 This shows the linear history of the current branch only.
323 Merge commits which affected the current branch will be shown but
324 individual commits which originated on other branches will be omitted.
326 Limit history traversal to a given number of commits.
327 If this option is not specified, a default limit value of zero is used,
328 which is treated as an unbounded limit.
330 .Ev GOT_LOG_DEFAULT_LIMIT
331 environment variable may be set to change this default value.
333 Display the patch of modifications made in each commit.
336 is specified, only show the patch of modifications at or within this path.
337 .It Fl r Ar repository-path
338 Use the repository at the specified path.
339 If not specified, assume the repository is located at or above the current
341 If this directory is a
343 work tree, use the repository path associated with this work tree.
345 .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
346 When invoked within a work tree with less than two arguments, display
347 uncommitted changes in the work tree.
350 is specified, only show changes within this path.
352 If two arguments are provided, treat each argument as a reference, a tag
353 name, or an object ID SHA1 hash, and display differences between the
354 corresponding objects.
355 Both objects must be of the same type (blobs, trees, or commits).
356 An abbreviated hash argument will be expanded to a full SHA1 hash
357 automatically, provided the abbreviation is unique.
364 Set the number of context lines shown in the diff.
365 By default, 3 lines of context are shown.
366 .It Fl r Ar repository-path
367 Use the repository at the specified path.
368 If not specified, assume the repository is located at or above the current
370 If this directory is a
372 work tree, use the repository path associated with this work tree.
374 Show changes staged with
376 instead of showing local changes.
377 This option is only valid when
379 is invoked in a work tree.
384 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
385 Display line-by-line history of a file at the specified path.
392 Start traversing history at the specified
394 The expected argument is a commit ID SHA1 hash or an existing reference
395 or tag name which will be resolved to a commit ID.
396 An abbreviated hash argument will be expanded to a full SHA1 hash
397 automatically, provided the abbreviation is unique.
398 .It Fl r Ar repository-path
399 Use the repository at the specified path.
400 If not specified, assume the repository is located at or above the current
402 If this directory is a
404 work tree, use the repository path associated with this work tree.
409 .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
410 Display a listing of files and directories at the specified
411 directory path in the repository.
412 Entries shown in this listing may carry one of the following trailing
414 .Bl -column YXZ description
415 .It @ Ta entry is a symbolic link
416 .It / Ta entry is a directory
417 .It * Ta entry is an executable file
418 .It $ Ta entry is a Git submodule
423 is specified, list the repository path corresponding to the current
424 directory of the work tree, or the root directory of the repository
425 if there is no work tree.
432 List files and directories as they appear in the specified
434 The expected argument is a commit ID SHA1 hash or an existing reference
435 or tag name which will be resolved to a commit ID.
436 An abbreviated hash argument will be expanded to a full SHA1 hash
437 automatically, provided the abbreviation is unique.
438 .It Fl r Ar repository-path
439 Use the repository at the specified path.
440 If not specified, assume the repository is located at or above the current
442 If this directory is a
444 work tree, use the repository path associated with this work tree.
446 Show object IDs of files (blob objects) and directories (tree objects).
448 Recurse into sub-directories in the repository.
453 .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
454 Manage references in a repository.
456 If no options are passed, expect two arguments and attempt to create,
457 or update, the reference with the given
459 and make it point at the given
461 The target may be an object ID SHA1 hash or an existing reference which
462 will be resolved to an object ID.
463 An abbreviated hash argument will be expanded to a full SHA1 hash
464 automatically, provided the abbreviation is unique.
470 .It Fl r Ar repository-path
471 Use the repository at the specified path.
472 If not specified, assume the repository is located at or above the current
474 If this directory is a
476 work tree, use the repository path associated with this work tree.
478 List all existing references in the repository.
480 Delete the reference with the specified name from the repository.
482 Create a symbolic reference pointing at the specified
484 which must be an existing reference.
485 Care should be taken not to create loops between references when
488 .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
489 Manage branches in a repository.
491 Branches are managed via references which live in the
496 command operates on references in this namespace only.
498 If no options are passed, expect one or two arguments and attempt to create
499 a branch reference with the given
501 and make it point at the given
505 argument is a commit ID SHA1 hash or an existing reference
506 or tag name which will be resolved to a commit ID.
509 is specified, default to the latest commit on the work tree's current
510 branch if invoked in a work tree, or to a commit resolved via the
511 repository's HEAD reference.
517 .It Fl r Ar repository-path
518 Use the repository at the specified path.
519 If not specified, assume the repository is located at or above the current
521 If this directory is a
523 work tree, use the repository path associated with this work tree.
525 List all existing branches in the repository.
526 If invoked in a work tree, the work tree's current branch is shown
527 with one the following annotations:
528 .Bl -column YXZ description
529 .It * Ta work tree's base commit matches the branch tip
530 .It \(a~ Ta work tree's base commit is out-of-date
533 Delete the branch with the specified name from the repository.
534 Only the branch reference is deleted.
535 Any commit, tree, and blob objects belonging to the branch
536 remain in the repository and may be removed separately with
537 Git's garbage collector.
542 .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
543 Manage tags in a repository.
545 Tags are managed via references which live in the
550 command operates on references in this namespace only.
551 References in this namespace point at tag objects which contain a pointer
552 to another object, a tag message, as well as author and timestamp information.
554 Expect one or two arguments and attempt to create a tag with the given
556 and make this tag point at the given
558 If no commit is specified, default to the latest commit on the work tree's
559 current branch if invoked in a work tree, and to a commit resolved via
560 the repository's HEAD reference otherwise.
561 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
562 reference or tag name which will be resolved to a commit ID.
563 An abbreviated hash argument will be expanded to a full SHA1 hash
564 automatically, provided the abbreviation is unique.
571 Use the specified tag message when creating the new tag
576 opens a temporary file in an editor where a tag message can be written.
577 .It Fl r Ar repository-path
578 Use the repository at the specified path.
579 If not specified, assume the repository is located at or above the current
581 If this directory is a
583 work tree, use the repository path associated with this work tree.
585 List all existing tags in the repository instead of creating a new tag.
586 If this option is used, no other command-line arguments are allowed.
591 command will not delete tags or change existing tags.
592 If a tag must be deleted, the
594 command may be used to delete a tag's reference.
595 This should only be done if the tag has not already been copied to
597 .It Cm add Ar file-path ...
598 Schedule unversioned files in a work tree for addition to the
599 repository in the next commit.
600 .It Cm remove Ar file-path ...
601 Remove versioned files from a work tree and schedule them for deletion
602 from the repository in the next commit.
609 Perform the operation even if a file contains uncommitted modifications.
614 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
615 Revert any uncommitted changes in files at the specified paths.
616 File contents will be overwritten with those contained in the
617 work tree's base commit.
618 There is no way to bring discarded changes back after
621 If a file was added with
623 it will become an unversioned file again.
624 If a file was deleted with
633 Instead of reverting all changes in files, interactively select or reject
634 changes to revert based on
640 (quit reverting this file) responses.
641 If a file is in modified status, individual patches derived from the
642 modified file content can be reverted.
643 Files in added or deleted status may only be reverted in their entirety.
644 .It Fl F Ar response-script
652 responses line-by-line from the specified
654 file instead of prompting interactively.
656 Permit recursion into directories.
657 If this option is not specified,
659 will refuse to run if a specified
666 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
667 Create a new commit in the repository from changes in a work tree
668 and use this commit as the new base commit for the work tree.
671 is specified, commit all changes in the work tree.
672 Otherwise, commit changes at or within the specified paths.
674 If changes have been explicitly staged for commit with
676 only commit staged changes and reject any specified paths which
677 have not been staged.
679 Show the status of each affected file, using the following status codes:
680 .Bl -column YXZ description
681 .It M Ta modified file
682 .It D Ta file was deleted
683 .It A Ta new file was added
686 Files which are not part of the new commit will retain their previously
687 recorded base commit.
690 commands may refuse to run while the work tree contains files from
691 multiple base commits.
692 The base commit of such a work tree can be made consistent by running
694 across the entire work tree.
700 environment variable to be set,
704 .Dv user.email configuration settings can be
705 obtained from the repository's
714 Use the specified log message when creating the new commit.
719 opens a temporary file in an editor where a log message can be written.
723 will refuse to run if certain preconditions are not met.
724 If the work tree's current branch is not in the
726 reference namespace, new commits may not be created on this branch.
727 Local changes may only be committed if they are based on file content
728 found in the most recent commit on the work tree's branch.
729 If a path is found to be out of date,
731 must be used first in order to merge local changes with changes made
736 .It Cm cherrypick Ar commit
737 Merge changes from a single
742 must be on a different branch than the work tree's base commit.
743 The expected argument is a reference or a commit ID SHA1 hash.
744 An abbreviated hash argument will be expanded to a full SHA1 hash
745 automatically, provided the abbreviation is unique.
747 Show the status of each affected file, using the following status codes:
748 .Bl -column YXZ description
749 .It G Ta file was merged
750 .It C Ta file was merged and conflicts occurred during merge
751 .It ! Ta changes destined for a missing file were not merged
752 .It D Ta file was deleted
753 .It d Ta file's deletion was obstructed by local modifications
754 .It A Ta new file was added
755 .It \(a~ Ta changes destined for a non-regular file were not merged
758 The merged changes will appear as local changes in the work tree, which
761 amended manually or with further
766 or discarded again with
770 will refuse to run if certain preconditions are not met.
771 If the work tree contains multiple base commits it must first be updated
772 to a single base commit with
774 If the work tree already contains files with merge conflicts, these
775 conflicts must be resolved first.
779 .It Cm backout Ar commit
780 Reverse-merge changes from a single
785 must be on the same branch as the work tree's base commit.
786 The expected argument is a reference or a commit ID SHA1 hash.
787 An abbreviated hash argument will be expanded to a full SHA1 hash
788 automatically, provided the abbreviation is unique.
790 Show the status of each affected file, using the following status codes:
791 .Bl -column YXZ description
792 .It G Ta file was merged
793 .It C Ta file was merged and conflicts occurred during merge
794 .It ! Ta changes destined for a missing file were not merged
795 .It D Ta file was deleted
796 .It d Ta file's deletion was obstructed by local modifications
797 .It A Ta new file was added
798 .It \(a~ Ta changes destined for a non-regular file were not merged
801 The reverse-merged changes will appear as local changes in the work tree,
802 which may be viewed with
804 amended manually or with further
809 or discarded again with
813 will refuse to run if certain preconditions are not met.
814 If the work tree contains multiple base commits it must first be updated
815 to a single base commit with
817 If the work tree already contains files with merge conflicts, these
818 conflicts must be resolved first.
822 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
823 Rebase commits on the specified
825 onto the tip of the current branch of the work tree.
828 must share common ancestry with the work tree's current branch.
829 Rebasing begins with the first descendant commit of the youngest
830 common ancestor commit shared by the specified
832 and the work tree's current branch, and stops once the tip commit
837 Rebased commits are accumulated on a temporary branch which the work tree
838 will remain switched to throughout the entire rebase operation.
839 Commits on this branch represent the same changes with the same log
840 messages as their counterparts on the original
842 but with different commit IDs.
843 Once rebasing has completed successfully, the temporary branch becomes
844 the new version of the specified
846 and the work tree is automatically switched to it.
848 While rebasing commits, show the status of each affected file,
849 using the following status codes:
850 .Bl -column YXZ description
851 .It G Ta file was merged
852 .It C Ta file was merged and conflicts occurred during merge
853 .It ! Ta changes destined for a missing file were not merged
854 .It D Ta file was deleted
855 .It d Ta file's deletion was obstructed by local modifications
856 .It A Ta new file was added
857 .It \(a~ Ta changes destined for a non-regular file were not merged
860 If merge conflicts occur the rebase operation is interrupted and may
861 be continued once conflicts have been resolved.
862 Alternatively, the rebase operation may be aborted which will leave
864 unmodified and the work tree switched back to its original branch.
866 If a merge conflict is resolved in a way which renders the merged
867 change into a no-op change, the corresponding commit will be elided
868 when the rebase operation continues.
871 will refuse to run if certain preconditions are not met.
872 If the work tree contains multiple base commits it must first be updated
873 to a single base commit with
875 If changes have been staged with
877 these changes must first be committed with
881 If the work tree contains local changes, these changes must first be
888 contains changes to files outside of the work tree's path prefix,
889 the work tree cannot be used to rebase this branch.
895 commands will refuse to run while a rebase operation is in progress.
896 Other commands which manipulate the work tree may be used for
897 conflict resolution purposes.
904 Abort an interrupted rebase operation.
905 If this option is used, no other command-line arguments are allowed.
907 Continue an interrupted rebase operation.
908 If this option is used, no other command-line arguments are allowed.
913 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
914 Edit commit history between the work tree's current base commit and
915 the tip commit of the work tree's current branch.
917 Editing of commit history is controlled via a
919 which can be edited interactively or passed on the command line.
920 The format of the histedit script is line-based.
921 Each line in the script begins with a command name, followed by
922 whitespace and an argument.
923 For most commands, the expected argument is a commit ID SHA1 hash.
924 Any remaining text on the line is ignored.
925 Lines which begin with the
927 character are ignored entirely.
929 The available commands are as follows:
930 .Bl -column YXZ pick-commit
931 .It pick Ar commit Ta Use the specified commit as it is.
932 .It edit Ar commit Ta Use the specified commit but once changes have been
933 merged into the work tree interrupt the histedit operation for amending.
934 .It fold Ar commit Ta Combine the specified commit with the next commit
935 listed further below that will be used.
936 .It drop Ar commit Ta Remove this commit from the edited history.
937 .It mesg Ar log-message Ta Use the specified single-line log message for
938 the commit on the previous line.
939 If the log message argument is left empty, open an editor where a new
940 log message can be written.
943 Every commit in the history being edited must be mentioned in the script.
944 Lines may be re-ordered to change the order of commits in the edited history.
946 Edited commits are accumulated on a temporary branch which the work tree
947 will remain switched to throughout the entire histedit operation.
948 Once history editing has completed successfully, the temporary branch becomes
949 the new version of the work tree's branch and the work tree is automatically
952 While merging commits, show the status of each affected file,
953 using the following status codes:
954 .Bl -column YXZ description
955 .It G Ta file was merged
956 .It C Ta file was merged and conflicts occurred during merge
957 .It ! Ta changes destined for a missing file were not merged
958 .It D Ta file was deleted
959 .It d Ta file's deletion was obstructed by local modifications
960 .It A Ta new file was added
961 .It \(a~ Ta changes destined for a non-regular file were not merged
964 If merge conflicts occur the histedit operation is interrupted and may
965 be continued once conflicts have been resolved.
966 Alternatively, the histedit operation may be aborted which will leave
967 the work tree switched back to its original branch.
969 If a merge conflict is resolved in a way which renders the merged
970 change into a no-op change, the corresponding commit will be elided
971 when the histedit operation continues.
974 will refuse to run if certain preconditions are not met.
975 If the work tree's current branch is not in the
977 reference namespace, the history of the branch may not be edited.
978 If the work tree contains multiple base commits it must first be updated
979 to a single base commit with
981 If changes have been staged with
983 these changes must first be committed with
987 If the work tree contains local changes, these changes must first be
992 If the edited history contains changes to files outside of the work tree's
993 path prefix, the work tree cannot be used to edit the history of this branch.
997 command will refuse to run while a histedit operation is in progress.
998 Other commands which manipulate the work tree may be used, and the
1000 command may be used to commit arbitrary changes to the temporary branch
1001 while the histedit operation is interrupted.
1008 Abort an interrupted histedit operation.
1009 If this option is used, no other command-line arguments are allowed.
1011 Continue an interrupted histedit operation.
1012 If this option is used, no other command-line arguments are allowed.
1017 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1018 Stage local changes for inclusion in the next commit.
1021 is specified, stage all changes in the work tree.
1022 Otherwise, stage changes at or within the specified paths.
1023 Paths may be staged if they are added, modified, or deleted according to
1026 Show the status of each affected file, using the following status codes:
1027 .Bl -column YXZ description
1028 .It A Ta file addition has been staged
1029 .It M Ta file modification has been staged
1030 .It D Ta file deletion has been staged
1033 Staged file contents are saved in newly created blob objects in the repository.
1034 These blobs will be referred to by tree objects once staged changes have been
1037 Staged changes affect the behaviour of
1042 While paths with staged changes exist, the
1044 command will refuse to commit any paths which do not have staged changes.
1045 Local changes created on top of staged changes can only be committed if
1046 the path is staged again, or if the staged changes are committed first.
1049 command will show both local changes and staged changes.
1052 command is able to display local changes relative to staged changes,
1053 and to display staged changes relative to the repository.
1056 command cannot revert staged changes but may be used to revert
1057 local changes created on top of staged changes.
1064 Instead of staging new changes, list paths which are already staged,
1065 along with the IDs of staged blob objects and stage status codes.
1066 If paths were provided in the command line show the staged paths
1067 among the specified paths.
1068 Otherwise, show all staged paths.
1070 Instead of staging the entire content of a changed file, interactively
1071 select or reject changes for staging based on
1075 (reject change), and
1077 (quit staging this file) responses.
1078 If a file is in modified status, individual patches derived from the
1079 modified file content can be staged.
1080 Files in added or deleted status may only be staged or rejected in
1082 .It Fl F Ar response-script
1090 responses line-by-line from the specified
1092 file instead of prompting interactively.
1096 will refuse to run if certain preconditions are not met.
1097 If a file contains merge conflicts, these conflicts must be resolved first.
1098 If a file is found to be out of date relative to the head commit on the
1099 work tree's current branch, the file must be updated with
1101 before it can be staged (however, this does not prevent the file from
1102 becoming out-of-date at some point after having been staged).
1109 commands will refuse to run while staged changes exist.
1110 If staged changes cannot be committed because a staged path
1111 is out of date, the path must be unstaged with
1113 before it can be updated with
1115 and may then be staged again if necessary.
1119 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1120 Merge staged changes back into the work tree and put affected paths
1121 back into non-staged status.
1124 is specified, unstage all staged changes across the entire work tree.
1125 Otherwise, unstage changes at or within the specified paths.
1127 Show the status of each affected file, using the following status codes:
1128 .Bl -column YXZ description
1129 .It G Ta file was unstaged
1130 .It C Ta file was unstaged and conflicts occurred during merge
1131 .It ! Ta changes destined for a missing file were not merged
1132 .It D Ta file was staged as deleted and still is deleted
1133 .It d Ta file's deletion was obstructed by local modifications
1134 .It \(a~ Ta changes destined for a non-regular file were not merged
1142 Instead of unstaging the entire content of a changed file, interactively
1143 select or reject changes for unstaging based on
1147 (keep change staged), and
1149 (quit unstaging this file) responses.
1150 If a file is staged in modified status, individual patches derived from the
1151 staged file content can be unstaged.
1152 Files staged in added or deleted status may only be unstaged in their entirety.
1153 .It Fl F Ar response-script
1161 responses line-by-line from the specified
1163 file instead of prompting interactively.
1168 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1169 Parse and print contents of objects to standard output in a line-based
1171 Content of commit, tree, and tag objects is printed in a way similar
1172 to the actual content stored in such objects.
1173 Blob object contents are printed as they would appear in files on disk.
1175 Attempt to interpret each argument as a reference, a tag name, or
1176 an object ID SHA1 hash.
1177 References will be resolved to an object ID.
1178 Tag names will resolved to a tag object.
1179 An abbreviated hash argument will be expanded to a full SHA1 hash
1180 automatically, provided the abbreviation is unique.
1182 If none of the above interpretations produce a valid result, or if the
1184 option is used, attempt to interpret the argument as a path which will
1185 be resolved to the ID of an object found at this path in the repository.
1192 Look up paths in the specified
1194 If this option is not used, paths are looked up in the commit resolved
1195 via the repository's HEAD reference.
1196 The expected argument is a commit ID SHA1 hash or an existing reference
1197 or tag name which will be resolved to a commit ID.
1198 An abbreviated hash argument will be expanded to a full SHA1 hash
1199 automatically, provided the abbreviation is unique.
1200 .It Fl r Ar repository-path
1201 Use the repository at the specified path.
1202 If not specified, assume the repository is located at or above the current
1204 If this directory is a
1206 work tree, use the repository path associated with this work tree.
1208 Interpret all arguments as paths only.
1209 This option can be used to resolve ambiguity in cases where paths
1210 look like tag names, reference names, or object IDs.
1214 .Bl -tag -width GOT_AUTHOR
1216 The author's name and email address for
1221 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1224 may fail to parse commits without an email address in author data,
1228 environment variables with a missing email address.
1232 .Dv user.email configuration settings in the repository's
1234 file will override the value of
1236 .It Ev VISUAL , EDITOR
1237 The editor spawned by
1242 .It Ev GOT_LOG_DEFAULT_LIMIT
1243 The default limit on the number of commits traversed by
1245 If set to zero, the limit is unbounded.
1246 This variable will be silently ignored if it is set to a non-numeric value.
1251 Clone an existing Git repository for use with
1253 This step currently requires
1257 .Dl $ git clone --bare https://github.com/openbsd/src.git
1259 Alternatively, for quick and dirty local testing of
1261 a new Git repository could be created and populated with files,
1262 e.g. from a temporary CVS checkout located at
1265 .Dl $ got init /var/git/src.git
1266 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1268 Check out a work tree from the Git repository to /usr/src:
1270 .Dl $ got checkout /var/git/src.git /usr/src
1272 View local changes in a work tree directory:
1275 .Dl $ got diff | less
1277 Interactively revert selected local changes in a work tree directory:
1279 .Dl $ got revert -p -R\ .
1281 In a work tree or a git repository directory, list all branch references:
1285 In a work tree or a git repository directory, create a new branch called
1286 .Dq unified-buffer-cache
1287 which is forked off the
1291 .Dl $ got branch unified-buffer-cache master
1293 Switch an existing work tree to the branch
1294 .Dq unified-buffer-cache .
1295 Local changes in the work tree will be preserved and merged if necessary:
1297 .Dl $ got update -b unified-buffer-cache
1299 Create a new commit from local changes in a work tree directory.
1300 This new commit will become the head commit of the work tree's current branch:
1304 In a work tree or a git repository directory, view changes committed in
1305 the 3 most recent commits to the work tree's branch, or the branch resolved
1306 via the repository's HEAD reference, respectively:
1308 .Dl $ got log -p -l 3 -f
1310 Add new files and remove obsolete files in a work tree directory:
1312 .Dl $ got add sys/uvm/uvm_ubc.c
1313 .Dl $ got remove sys/uvm/uvm_vnode.c
1315 Create a new commit from local changes in a work tree directory
1316 with a pre-defined log message.
1318 .Dl $ got commit -m 'unify the buffer cache'
1320 Update any work tree checked out from the
1321 .Dq unified-buffer-cache
1322 branch to the latest commit on this branch:
1326 Roll file content on the unified-buffer-cache branch back by one commit,
1327 and then fetch the rolled-back change into the work tree as a local change
1328 to be amended and perhaps committed again:
1330 .Dl $ got backout unified-buffer-cache
1331 .Dl $ got commit -m 'roll back previous'
1332 .Dl $ # now back out the previous backout :-)
1333 .Dl $ got backout unified-buffer-cache
1335 Fetch new upstream commits into the local repository's master branch.
1336 This step currently requires
1339 .Dl $ cd /var/git/src.git
1340 .Dl $ git fetch origin master:master
1343 .Dq unified-buffer-cache
1344 branch on top of the new head commit of the
1348 .Dl $ got update -b master
1349 .Dl $ got rebase unified-buffer-cache
1351 Create a patch from all changes on the unified-buffer-cache branch.
1352 The patch can be mailed out for review and applied to
1356 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1358 Edit the entire commit history of the
1359 .Dq unified-buffer-cache
1362 .Dl $ got update -b unified-buffer-cache
1363 .Dl $ got update -c master
1366 Additional steps are necessary if local changes need to be pushed back
1367 to the remote repository, which currently requires
1371 Before working against existing branches in a repository cloned with
1372 .Dq git clone --bare ,
1375 must be configured to map all references in the remote repository
1378 namespace of the local repository.
1379 This can achieved by setting Git's
1380 .Pa remote.origin.fetch
1381 configuration variable to the value
1382 .Dq +refs/heads/*:refs/remotes/origin/*
1387 .Dl $ cd /var/git/repo
1388 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1390 Alternatively, the following
1392 configuration item can be added manually to the Git repository's
1396 .Dl [remote "origin"]
1398 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1400 This configuration leaves the local repository's
1402 namespace free for use by local branches checked out with
1404 and, if needed, created with
1409 namespace can be updated with incoming changes from the remote
1413 .Dl $ cd /var/git/repo
1416 Before outgoing changes on the local
1418 branch can be pushed to the remote repository, the local
1420 branch must be rebased onto the
1424 .Dl $ got update -b origin/master
1425 .Dl $ got rebase master
1427 Changes on the local
1429 branch can then be pushed to the remote
1433 .Dl $ cd /var/git/repo
1434 .Dl $ git push origin master
1437 .Xr git-repository 5 ,
1440 .An Stefan Sperling Aq Mt stsp@openbsd.org
1441 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1442 .An Joshua Stein Aq Mt jcs@openbsd.org
1445 is a work-in-progress and many commands remain to be implemented.
1446 At present, the user has to fall back on
1448 to perform many tasks, in particular tasks related to repository
1449 administration and tasks which require a network connection.
