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 preceed 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
80 .It Cm import [ Fl b Ar branch ] [ Fl m Ar message ] [ Fl r Ar repository-path ] [ Fl I Ar pattern ] directory
81 Create an initial commit in a repository from the file hierarchy
84 The created commit will not have any parent commits, i.e. it will be a
86 Also create a new reference which provides a branch name for the newly
88 Show the path of each imported file to indicate progress.
94 environment variable to be set.
103 instead of creating the default branch
105 Use of this option is required if the
107 branch already exists.
109 Use the specified log message when creating the new commit.
114 opens a temporary file in an editor where a log message can be written.
115 .It Fl r Ar repository-path
116 Use the repository at the specified path.
117 If not specified, assume the repository is located at or above the current
120 Ignore files or directories with a name which matches the specified
122 This option may be specified multiple times to build a list of ignore patterns.
125 follows the globbing rules documented in
131 .It Cm checkout [ Fl b Ar branch ] [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
132 Copy files from a repository into a new work tree.
135 is not specified, either use the last component of
136 .Ar repository path ,
139 was specified use the last component of
147 Check out files from a commit on the specified
149 If this option is not specified, a branch resolved via the repository's HEAD
150 reference will be used.
152 Check out files from the specified
154 on the selected branch.
155 The expected argument is a commit ID SHA1 hash or an existing reference
156 which will be resolved to a commit ID.
157 An abbreviated hash argument will be expanded to a full SHA1 hash
158 automatically, provided the abbreviation is unique.
159 If this option is not specified, the most recent commit on the selected
161 .It Fl p Ar path-prefix
162 Restrict the work tree to a subset of the repository's tree hierarchy.
163 Only files beneath the specified
170 .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ... ]
171 Update an existing work tree to a different commit.
172 Show the status of each affected file, using the following status codes:
173 .Bl -column YXZ description
174 .It U Ta file was updated and contained no local changes
175 .It G Ta file was updated and local changes were merged cleanly
176 .It C Ta file was updated and conflicts occurred during merge
177 .It D Ta file was deleted
178 .It A Ta new file was added
179 .It ~ Ta versioned file is obstructed by a non-regular file
180 .It ! Ta a missing versioned file was restored
185 is specified, update the entire work tree.
186 Otherwise, restrict the update operation to files at or within the
188 Each path is required to exist in the update operation's target commit.
189 Files in the work tree outside specified paths will remain unchanged and
190 will retain their previously recorded base commit.
193 commands may refuse to run while the work tree contains files from
194 multiple base commits.
195 The base commit of such a work tree can be made consistent by running
197 across the entire work tree.
200 is incompatible with the
205 cannot update paths with staged changes.
206 If changes have been staged with
208 these changes must first be comitted with
218 Switch the work tree's branch reference to the specified
220 before updating the work tree.
221 This option requires that all paths in the work tree are updated.
223 Update the work tree to the specified
225 The expected argument is a commit ID SHA1 hash or an existing reference
226 which will be resolved to a commit ID.
227 An abbreviated hash argument will be expanded to a full SHA1 hash
228 automatically, provided the abbreviation is unique.
229 If this option is not specified, the most recent commit on the work tree's
235 .It Cm status [ Ar path ... ]
236 Show the current modification status of files in a work tree,
237 using the following status codes:
238 .Bl -column YXZ description
239 .It M Ta modified file
240 .It A Ta file scheduled for addition in next commit
241 .It D Ta file scheduled for deletion in next commit
242 .It C Ta modified or added file which contains merge conflicts
243 .It ! Ta versioned file was expected on disk but is missing
244 .It ~ Ta versioned file is obstructed by a non-regular file
245 .It ? Ta unversioned item not tracked by
251 is specified, show modifications in the entire work tree.
252 Otherwise, show modifications at or within the specified paths.
254 If changes have been staged with
256 staged changes are shown in the second output column, using the following
258 .Bl -column YXZ description
259 .It M Ta file modification is staged
260 .It A Ta file addition is staged
261 .It D Ta file deletion is staged
264 Changes created on top of staged changes are indicated in the first column:
265 .Bl -column YXZ description
266 .It MM Ta file was modified after earlier changes have been staged
267 .It MA Ta file was modified after having been staged for addition
270 For compatibility with
275 files in each traversed directory and will not display unversioned files
278 ignore patterns contained in
284 only supports a single ignore pattern per line.
288 .It Cm log [ Fl c Ar commit ] [ Fl C Ar number ] [ Fl f ] [ Fl l Ar N ] [ Fl p ] [ Fl r Ar repository-path ] [ path ]
289 Display history of a repository.
292 is specified, show only commits which modified this path.
299 Start traversing history at the specified
301 The expected argument is a commit ID SHA1 hash or an existing reference
302 which will be resolved to a commit ID.
303 An abbreviated hash argument will be expanded to a full SHA1 hash
304 automatically, provided the abbreviation is unique.
305 If this option is not specified, default to the work tree's current branch
306 if invoked in a work tree, or to the repository's HEAD reference.
308 Set the number of context lines shown in diffs with
310 By default, 3 lines of context are shown.
312 Restrict history traversal to the first parent of each commit.
313 This shows the linear history of the current branch only.
314 Merge commits which affected the current branch will be shown but
315 individual commits which originated on other branches will be omitted.
317 Limit history traversal to a given number of commits.
319 Display the patch of modifications made in each commit.
320 .It Fl r Ar repository-path
321 Use the repository at the specified path.
322 If not specified, assume the repository is located at or above the current
324 If this directory is a
326 work tree, use the repository path associated with this work tree.
328 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Fl s ] [ Ar object1 Ar object2 | Ar path ]
329 When invoked within a work tree with less than two arguments, display
330 uncommitted changes in the work tree.
333 is specified, only show changes within this path.
335 If two arguments are provided, treat each argument as a reference,
336 or an object ID SHA1 hash, and display differences between these objects.
337 Both objects must be of the same type (blobs, trees, or commits).
338 An abbreviated hash argument will be expanded to a full SHA1 hash
339 automatically, provided the abbreviation is unique.
346 Set the number of context lines shown in the diff.
347 By default, 3 lines of context are shown.
348 .It Fl r Ar repository-path
349 Use the repository at the specified path.
350 If not specified, assume the repository is located at or above the current
352 If this directory is a
354 work tree, use the repository path associated with this work tree.
356 Show changes staged with
358 instead of showing local changes.
359 This option is only valid when
361 is invoked in a work tree.
366 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
367 Display line-by-line history of a file at the specified path.
374 Start traversing history at the specified
376 The expected argument is a commit ID SHA1 hash or an existing reference
377 which will be resolved to a commit ID.
378 An abbreviated hash argument will be expanded to a full SHA1 hash
379 automatically, provided the abbreviation is unique.
380 .It Fl r Ar repository-path
381 Use the repository at the specified path.
382 If not specified, assume the repository is located at or above the current
384 If this directory is a
386 work tree, use the repository path associated with this work tree.
391 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
392 Display a listing of files and directories at the specified
393 directory path in the repository.
394 Entries shown in this listing may carry one of the following trailing
396 .Bl -column YXZ description
397 .It / Ta entry is a directory
398 .It * Ta entry is an executable file
403 is specified, list the repository path corresponding to the current
404 directory of the work tree, or the root directory of the repository
405 if there is no work tree.
412 List files and directories as they appear in the specified
414 The expected argument is a commit ID SHA1 hash or an existing reference
415 which will be resolved to a commit ID.
416 An abbreviated hash argument will be expanded to a full SHA1 hash
417 automatically, provided the abbreviation is unique.
418 .It Fl r Ar repository-path
419 Use the repository at the specified path.
420 If not specified, assume the repository is located at or above the current
422 If this directory is a
424 work tree, use the repository path associated with this work tree.
426 Show object IDs of files (blob objects) and directories (tree objects).
428 Recurse into sub-directories in the repository.
433 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
434 Manage references in a repository.
436 If no options are passed, expect two arguments and attempt to create,
437 or update, the reference with the given
439 and make it point at the given
441 The target may be an object ID SHA1 hash or an existing reference which
442 will be resolved to an object ID.
443 An abbreviated hash argument will be expanded to a full SHA1 hash
444 automatically, provided the abbreviation is unique.
450 .It Fl r Ar repository-path
451 Use the repository at the specified path.
452 If not specified, assume the repository is located at or above the current
454 If this directory is a
456 work tree, use the repository path associated with this work tree.
458 List all existing references in the repository.
460 Delete the reference with the specified name from the repository.
462 .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
463 Manage branches in a repository.
465 Branches are managed via references which live in the
470 command operates on references in this namespace only.
472 If no options are passed, expect one or two arguments and attempt to create
473 a branch with the given
475 and make it point at the given
479 is specified, default to the work tree's current branch if invoked in a
480 work tree, or to the repository's HEAD reference.
486 .It Fl r Ar repository-path
487 Use the repository at the specified path.
488 If not specified, assume the repository is located at or above the current
490 If this directory is a
492 work tree, use the repository path associated with this work tree.
494 List all existing branches in the repository.
495 If invoked in a work tree, the work tree's current branch is shown
496 with one the following annotations:
497 .Bl -column YXZ description
498 .It * Ta work tree's base commit matches the branch tip
499 .It ~ Ta work tree's base commit is out-of-date
502 Delete the branch with the specified name from the repository.
503 Only the branch reference is deleted.
504 Any commit, tree, and blob objects belonging to the branch
505 remain in the repository and may be removed separately with
506 Git's garbage collector.
511 .It Cm add Ar file-path ...
512 Schedule unversioned files in a work tree for addition to the
513 repository in the next commit.
514 .It Cm remove Ar file-path ...
515 Remove versioned files from a work tree and schedule them for deletion
516 from the repository in the next commit.
523 Perform the operation even if a file contains uncommitted modifications.
528 .It Cm revert [ Fl p ] [ Fl F Ar response-script ] [ Fl R ] Ar path ...
529 Revert any uncommited changes in files at the specified paths.
530 File contents will be overwritten with those contained in the
531 work tree's base commit. There is no way to bring discarded
535 If a file was added with
537 it will become an unversioned file again.
538 If a file was deleted with
547 Instead of reverting all changes in files, interactively select or reject
548 changes to revert based on
554 (quit reverting this file) responses.
555 If a file is in modified status, individual patches derived from the
556 modified file content can be reverted.
557 Files in added or deleted status may only be reverted in their entirety.
558 .It Fl F Ar response-script
566 responses line-by-line from the specified
568 file instead of prompting interactively.
570 Permit recursion into directories.
571 If this option is not specified,
573 will refuse to run if a specified
580 .It Cm commit [ Fl m Ar message ] [ path ... ]
581 Create a new commit in the repository from changes in a work tree
582 and use this commit as the new base commit for the work tree.
585 is specified, commit all changes in the work tree.
586 Otherwise, commit changes at or within the specified paths.
588 If changes have been explicitly staged for commit with
590 only commit staged changes and reject any specified paths which
591 have not been staged.
593 Show the status of each affected file, using the following status codes:
594 .Bl -column YXZ description
595 .It M Ta modified file
596 .It D Ta file was deleted
597 .It A Ta new file was added
600 Files which are not part of the new commit will retain their previously
601 recorded base commit.
604 commands may refuse to run while the work tree contains files from
605 multiple base commits.
606 The base commit of such a work tree can be made consistent by running
608 across the entire work tree.
614 environment variable to be set.
621 Use the specified log message when creating the new commit.
626 opens a temporary file in an editor where a log message can be written.
630 will refuse to run if certain preconditions are not met.
631 If the work tree's current branch is not in the
633 reference namespace, new commits may not be created on this branch.
634 Local changes may only be committed if they are based on file content
635 found in the most recent commit on the work tree's branch.
636 If a path is found to be out of date,
638 must be used first in order to merge local changes with changes made
643 .It Cm cherrypick Ar commit
644 Merge changes from a single
649 must be on a different branch than the work tree's base commit.
650 The expected argument is a reference or a commit ID SHA1 hash.
651 An abbreviated hash argument will be expanded to a full SHA1 hash
652 automatically, provided the abbreviation is unique.
654 Show the status of each affected file, using the following status codes:
655 .Bl -column YXZ description
656 .It G Ta file was merged
657 .It C Ta file was merged and conflicts occurred during merge
658 .It ! Ta changes destined for a missing file were not merged
659 .It D Ta file was deleted
660 .It d Ta file's deletion was obstructed by local modifications
661 .It A Ta new file was added
662 .It ~ Ta changes destined for a non-regular file were not merged
665 The merged changes will appear as local changes in the work tree, which
668 amended manually or with further
673 or discarded again with
677 will refuse to run if certain preconditions are not met.
678 If the work tree contains multiple base commits it must first be updated
679 to a single base commit with
681 If the work tree already contains files with merge conflicts, these
682 conflicts must be resolved first.
686 .It Cm backout Ar commit
687 Reverse-merge changes from a single
692 must be on the same branch as the work tree's base commit.
693 The expected argument is a reference or a commit ID SHA1 hash.
694 An abbreviated hash argument will be expanded to a full SHA1 hash
695 automatically, provided the abbreviation is unique.
697 Show the status of each affected file, using the following status codes:
698 .Bl -column YXZ description
699 .It G Ta file was merged
700 .It C Ta file was merged and conflicts occurred during merge
701 .It ! Ta changes destined for a missing file were not merged
702 .It D Ta file was deleted
703 .It d Ta file's deletion was obstructed by local modifications
704 .It A Ta new file was added
705 .It ~ Ta changes destined for a non-regular file were not merged
708 The reverse-merged changes will appear as local changes in the work tree,
709 which may be viewed with
711 amended manually or with further
716 or discarded again with
720 will refuse to run if certain preconditions are not met.
721 If the work tree contains multiple base commits it must first be updated
722 to a single base commit with
724 If the work tree already contains files with merge conflicts, these
725 conflicts must be resolved first.
729 .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
730 Rebase commits on the specified
732 onto the tip of the current branch of the work tree.
735 must share common ancestry with the work tree's current branch.
736 Rebasing begins with the first descendent commit of the youngest
737 common ancestor commit shared by the specified
739 and the work tree's current branch, and stops once the tip commit
744 Rebased commits are accumulated on a temporary branch which the work tree
745 will remain switched to throughout the entire rebase operation.
746 Commits on this branch represent the same changes with the same log
747 messages as their counterparts on the original
749 but with different commit IDs.
750 Once rebasing has completed successfully, the temporary branch becomes
751 the new version of the specified
753 and the work tree is automatically switched to it.
755 While rebasing commits, show the status of each affected file,
756 using the following status codes:
757 .Bl -column YXZ description
758 .It G Ta file was merged
759 .It C Ta file was merged and conflicts occurred during merge
760 .It ! Ta changes destined for a missing file were not merged
761 .It D Ta file was deleted
762 .It d Ta file's deletion was obstructed by local modifications
763 .It A Ta new file was added
764 .It ~ Ta changes destined for a non-regular file were not merged
767 If merge conflicts occur the rebase operation is interrupted and may
768 be continued once conflicts have been resolved.
769 Alternatively, the rebase operation may be aborted which will leave
771 unmodified and the work tree switched back to its original branch.
773 If a merge conflict is resolved in a way which renders the merged
774 change into a no-op change, the corresponding commit will be elided
775 when the rebase operation continues.
778 will refuse to run if certain preconditions are not met.
779 If the work tree contains multiple base commits it must first be updated
780 to a single base commit with
782 If changes have been staged with
784 these changes must first be comitted with
788 If the work tree contains local changes, these changes must first be
795 contains changes to files outside of the work tree's path prefix,
796 the work tree cannot be used to rebase this branch.
802 commands will refuse to run while a rebase operation is in progress.
803 Other commands which manipulate the work tree may be used for
804 conflict resolution purposes.
811 Abort an interrupted rebase operation.
812 If this option is used, no other command-line arguments are allowed.
814 Continue an interrupted rebase operation.
815 If this option is used, no other command-line arguments are allowed.
820 .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
821 Edit commit history between the work tree's current base commit and
822 the tip commit of the work tree's current branch.
824 Editing of commit history is controlled via a
826 which can be edited interactively or passed on the command line.
827 The format of the histedit script is line-based.
828 Each line in the script begins with a command name, followed by
829 whitespace and an argument.
830 For most commands, the expected argument is a commit ID SHA1 hash.
831 Any remaining text on the line is ignored.
832 Lines which begin with the
834 character are ignored entirely.
836 The available commands are as follows:
837 .Bl -column YXZ pick-commit
838 .It pick Ar commit Ta Use the specified commit as it is.
839 .It edit Ar commit Ta Use the specified commit but once changes have been
840 merged into the work tree interrupt the histedit operation for amending.
841 .It fold Ar commit Ta Combine the specified commit with the next commit
842 listed further below that will be used.
843 .It drop Ar commit Ta Remove this commit from the edited history.
844 .It mesg Ar log-message Ta Use the specified single-line log message for
845 the commit on the previous line.
846 If the log message argument is left empty, open an editor where a new
847 log message can be written.
850 Every commit in the history being edited must be mentioned in the script.
851 Lines may be re-ordered to change the order of commits in the edited history.
853 Edited commits are accumulated on a temporary branch which the work tree
854 will remain switched to throughout the entire histedit operation.
855 Once history editing has completed successfully, the temporary branch becomes
856 the new version of the work tree's branch and the work tree is automatically
859 While merging commits, show the status of each affected file,
860 using the following status codes:
861 .Bl -column YXZ description
862 .It G Ta file was merged
863 .It C Ta file was merged and conflicts occurred during merge
864 .It ! Ta changes destined for a missing file were not merged
865 .It D Ta file was deleted
866 .It d Ta file's deletion was obstructed by local modifications
867 .It A Ta new file was added
868 .It ~ Ta changes destined for a non-regular file were not merged
871 If merge conflicts occur the histedit operation is interrupted and may
872 be continued once conflicts have been resolved.
873 Alternatively, the histedit operation may be aborted which will leave
874 the work tree switched back to its original branch.
876 If a merge conflict is resolved in a way which renders the merged
877 change into a no-op change, the corresponding commit will be elided
878 when the histedit operation continues.
881 will refuse to run if certain preconditions are not met.
882 If the work tree's current branch is not in the
884 reference namespace, the history of the branch may not be edited.
885 If the work tree contains multiple base commits it must first be updated
886 to a single base commit with
888 If changes have been staged with
890 these changes must first be comitted with
894 If the work tree contains local changes, these changes must first be
899 If the edited history contains changes to files outside of the work tree's
900 path prefix, the work tree cannot be used to edit the history of this branch.
904 command will refuse to run while a histedit operation is in progress.
905 Other commands which manipulate the work tree may be used, and the
907 command may be used to commit arbitrary changes to the temporary branch
908 while the histedit operation is interrupted.
915 Abort an interrupted histedit operation.
916 If this option is used, no other command-line arguments are allowed.
918 Continue an interrupted histedit operation.
919 If this option is used, no other command-line arguments are allowed.
924 .It Cm stage [ Fl l ] [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
925 Stage local changes for inclusion in the next commit.
928 is specified, stage all changes in the work tree.
929 Otherwise, stage changes at or within the specified paths.
930 Paths may be staged if they are added, modified, or deleted according to
933 Show the status of each affected file, using the following status codes:
934 .Bl -column YXZ description
935 .It A Ta file addition has been staged
936 .It M Ta file modification has been staged
937 .It D Ta file deletion has been staged
940 Staged file contents are saved in newly created blob objects in the repository.
941 These blobs will be referred to by tree objects once staged changes have been
944 Staged changes affect the behaviour of
949 While paths with staged changes exist, the
951 command will refuse to commit any paths which do not have staged changes.
952 Local changes created on top of staged changes can only be committed if
953 the path is staged again, or if the staged changes are committed first.
956 command will show both local changes and staged changes.
959 command is able to display local changes relative to staged changes,
960 and to display staged changes relative to the repository.
963 command cannot revert staged changes but may be used to revert
964 local changes created on top of staged changes.
971 Instead of staging new changes, list paths which are already staged,
972 along with the IDs of staged blob objects and stage status codes.
973 If paths were provided in the command line show the staged paths
974 among the specified paths. Otherwise, show all staged paths.
976 Instead of staging the entire content of a changed file, interactively
977 select or reject changes for staging based on
983 (quit staging this file) responses.
984 If a file is in modified status, individual patches derived from the
985 modified file content can be staged.
986 Files in added or deleted status may only be staged or rejected in
988 .It Fl F Ar response-script
996 responses line-by-line from the specified
998 file instead of prompting interactively.
1002 will refuse to run if certain preconditions are not met.
1003 If a file contains merge conflicts, these conflicts must be resolved first.
1004 If a file is found to be out of date relative to the head commit on the
1005 work tree's current branch, the file must be updated with
1007 before it can be staged (however, this does not prevent the file from
1008 becoming out-of-date at some point after having been staged).
1015 commands will refuse to run while staged changes exist.
1016 If staged changes cannot be committed because a staged path
1017 is out of date, the path must be unstaged with
1019 before it can be updated with
1021 and may then be staged again if necessary.
1025 .It Cm unstage [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
1026 Merge staged changes back into the work tree and put affected paths
1027 back into non-staged status.
1030 is specified, unstage all staged changes across the entire work tree.
1031 Otherwise, unstage changes at or within the specified paths.
1033 Show the status of each affected file, using the following status codes:
1034 .Bl -column YXZ description
1035 .It G Ta file was unstaged
1036 .It C Ta file was unstaged and conflicts occurred during merge
1037 .It ! Ta changes destined for a missing file were not merged
1038 .It D Ta file was staged as deleted and still is deleted
1039 .It d Ta file's deletion was obstructed by local modifications
1040 .It ~ Ta changes destined for a non-regular file were not merged
1048 Instead of unstaging the entire content of a changed file, interactively
1049 select or reject changes for unstaging based on
1053 (keep change staged), and
1055 (quit unstaging this file) responses.
1056 If a file is staged in modified status, individual patches derived from the
1057 staged file content can be unstaged.
1058 Files staged in added or deleted status may only be unstaged in their entirety.
1059 .It Fl F Ar response-script
1067 responses line-by-line from the specified
1069 file instead of prompting interactively.
1076 .Bl -tag -width GOT_AUTHOR
1078 The author's name and email address for
1083 .An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1085 may fail to parse commits created with
1089 environment variable does not contain an email address.
1090 .It Ev VISUAL, Ev EDITOR
1091 The editor spawned by
1097 Clone an existing Git repository for use with
1099 This step currently requires
1103 .Dl $ git clone --bare https://github.com/openbsd/src.git
1105 Alternatively, for quick and dirty local testing of
1107 a new Git repository could be created and populated with files,
1108 e.g. from a temporary CVS checkout located at
1111 .Dl $ got init /var/git/src.git
1112 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1114 Check out a work tree from the Git repository to /usr/src:
1116 .Dl $ got checkout /var/git/src.git /usr/src
1118 View local changes in a work tree directory:
1121 .Dl $ got diff | less
1123 Interactively revert selected local changes in a work tree directory:
1125 .Dl $ got revert -p -R\ .
1127 In a work tree or a git repository directory, list all branch references:
1131 In a work tree or a git repository directory, create a new branch called
1132 .Dq unified-buffer-cache
1133 which is forked off the
1137 .Dl $ got branch unified-buffer-cache master
1139 Switch an existing work tree to the branch
1140 .Dq unified-buffer-cache .
1141 Local changes in the work tree will be preserved and merged if necessary:
1143 .Dl $ got update -b unified-buffer-cache
1145 Create a new commit from local changes in a work tree directory.
1146 This new commit will become the head commit of the work tree's current branch:
1150 In a work tree or a git repository directory, view changes committed in
1151 the 3 most recent commits to the work tree's branch, or the branch resolved
1152 via the repository's HEAD reference, respectively:
1154 .Dl $ got log -p -l 3 -f
1156 Add new files and remove obsolete files in a work tree directory:
1158 .Dl $ got add sys/uvm/uvm_ubc.c
1159 .Dl $ got remove sys/uvm/uvm_vnode.c
1161 Create a new commit from local changes in a work tree directory
1162 with a pre-defined log message.
1164 .Dl $ got commit -m 'unify the buffer cache'
1166 Update any work tree checked out from the
1167 .Dq unified-buffer-cache
1168 branch to the latest commit on this branch:
1172 Roll file content on the unified-buffer-cache branch back by one commit,
1173 and then fetch the rolled-back change into the work tree as a local change
1174 to be amended and perhaps committed again:
1176 .Dl $ got backout unified-buffer-cache
1177 .Dl $ got commit -m 'roll back previous'
1178 .Dl $ # now back out the previous backout :-)
1179 .Dl $ got backout unified-buffer-cache
1181 Fetch new upstream commits into the local repository's master branch.
1182 This step currently requires
1185 .Dl $ cd /var/git/src.git
1186 .Dl $ git fetch origin master:master
1189 .Dq unified-buffer-cache
1190 branch on top of the new head commit of the
1194 .Dl $ got update -b master
1195 .Dl $ got rebase unified-buffer-cache
1197 Create a patch from all changes on the unified-buffer-cache branch.
1198 The patch can be mailed out for review and applied to OpenBSD's CVS tree:
1200 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1202 Edit the entire commit history of the
1203 .Dq unified-buffer-cache
1206 .Dl $ got update -b unified-buffer-cache
1207 .Dl $ got update -c master
1210 Additional steps are necessary if local changes need to be pushed back
1211 to the remote repository, which currently requires
1215 Before working against existing branches in a repository cloned with
1216 .Dq git clone --bare ,
1219 must be configured to map all references in the remote repository
1222 namespace of the local repository.
1223 This can achieved by setting Git's
1224 .Pa remote.origin.fetch
1225 configuration variable to the value
1226 .Dq +refs/heads/*:refs/remotes/origin/*
1231 .Dl $ cd /var/git/repo
1232 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1234 Alternatively, the following
1236 configuration item can be added manually to the Git repository's
1240 .Dl [remote "origin"]
1242 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1244 This configuration leaves the local repository's
1246 namespace free for use by local branches checked out with
1248 and, if needed, created with
1253 namespace can be updated with incoming changes from the remote
1257 .Dl $ cd /var/git/repo
1260 Before outgoing changes on the local
1262 branch can be pushed to the remote repository, the local
1264 branch must be rebased onto the
1268 .Dl $ got update -b origin/master
1269 .Dl $ got rebase master
1271 Changes on the local
1273 branch can then be pushed to the remote
1277 .Dl $ cd /var/git/repo
1278 .Dl $ git push origin master
1282 .Xr git-repository 5 ,
1285 .An Stefan Sperling Aq Mt stsp@openbsd.org
1286 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1287 .An joshua stein Aq Mt jcs@openbsd.org
1290 is a work-in-progress and many commands remain to be implemented.
1291 At present, the user has to fall back on
1293 to perform many tasks, in particular tasks related to repository
1294 administration and tasks which require a network connection.
