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
272 .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 ]
273 Display history of a repository.
276 is specified, show only commits which modified this path.
283 Start traversing history at the specified
285 The expected argument is a commit ID SHA1 hash or an existing reference
286 which will be resolved to a commit ID.
287 An abbreviated hash argument will be expanded to a full SHA1 hash
288 automatically, provided the abbreviation is unique.
289 If this option is not specified, default to the work tree's current branch
290 if invoked in a work tree, or to the repository's HEAD reference.
292 Set the number of context lines shown in diffs with
294 By default, 3 lines of context are shown.
296 Restrict history traversal to the first parent of each commit.
297 This shows the linear history of the current branch only.
298 Merge commits which affected the current branch will be shown but
299 individual commits which originated on other branches will be omitted.
301 Limit history traversal to a given number of commits.
303 Display the patch of modifications made in each commit.
304 .It Fl r Ar repository-path
305 Use the repository at the specified path.
306 If not specified, assume the repository is located at or above the current
308 If this directory is a
310 work tree, use the repository path associated with this work tree.
312 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Fl s ] [ Ar object1 Ar object2 | Ar path ]
313 When invoked within a work tree with less than two arguments, display
314 uncommitted changes in the work tree.
317 is specified, only show changes within this path.
319 If two arguments are provided, treat each argument as a reference,
320 or an object ID SHA1 hash, and display differences between these objects.
321 Both objects must be of the same type (blobs, trees, or commits).
322 An abbreviated hash argument will be expanded to a full SHA1 hash
323 automatically, provided the abbreviation is unique.
330 Set the number of context lines shown in the diff.
331 By default, 3 lines of context are shown.
332 .It Fl r Ar repository-path
333 Use the repository at the specified path.
334 If not specified, assume the repository is located at or above the current
336 If this directory is a
338 work tree, use the repository path associated with this work tree.
340 Show changes staged with
342 instead of showing local changes.
343 This option is only valid when
345 is invoked in a work tree.
350 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
351 Display line-by-line history of a file at the specified path.
358 Start traversing history at the specified
360 The expected argument is a commit ID SHA1 hash or an existing reference
361 which will be resolved to a commit ID.
362 An abbreviated hash argument will be expanded to a full SHA1 hash
363 automatically, provided the abbreviation is unique.
364 .It Fl r Ar repository-path
365 Use the repository at the specified path.
366 If not specified, assume the repository is located at or above the current
368 If this directory is a
370 work tree, use the repository path associated with this work tree.
375 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
376 Display a listing of files and directories at the specified
377 directory path in the repository.
378 Entries shown in this listing may carry one of the following trailing
380 .Bl -column YXZ description
381 .It / Ta entry is a directory
382 .It * Ta entry is an executable file
387 is specified, list the repository path corresponding to the current
388 directory of the work tree, or the root directory of the repository
389 if there is no work tree.
396 List files and directories as they appear in the specified
398 The expected argument is a commit ID SHA1 hash or an existing reference
399 which will be resolved to a commit ID.
400 An abbreviated hash argument will be expanded to a full SHA1 hash
401 automatically, provided the abbreviation is unique.
402 .It Fl r Ar repository-path
403 Use the repository at the specified path.
404 If not specified, assume the repository is located at or above the current
406 If this directory is a
408 work tree, use the repository path associated with this work tree.
410 Show object IDs of files (blob objects) and directories (tree objects).
412 Recurse into sub-directories in the repository.
417 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
418 Manage references in a repository.
420 If no options are passed, expect two arguments and attempt to create,
421 or update, the reference with the given
423 and make it point at the given
425 The target may be an object ID SHA1 hash or an existing reference which
426 will be resolved to an object ID.
427 An abbreviated hash argument will be expanded to a full SHA1 hash
428 automatically, provided the abbreviation is unique.
434 .It Fl r Ar repository-path
435 Use the repository at the specified path.
436 If not specified, assume the repository is located at or above the current
438 If this directory is a
440 work tree, use the repository path associated with this work tree.
442 List all existing references in the repository.
444 Delete the reference with the specified name from the repository.
446 .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
447 Manage branches in a repository.
449 Branches are managed via references which live in the
454 command operates on references in this namespace only.
456 If no options are passed, expect one or two arguments and attempt to create
457 a branch with the given
459 and make it point at the given
463 is specified, default to the work tree's current branch if invoked in a
464 work tree, or to the repository's HEAD reference.
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 branches in the repository.
479 If invoked in a work tree, the work tree's current branch is shown
480 with one the following annotations:
481 .Bl -column YXZ description
482 .It * Ta work tree's base commit matches the branch tip
483 .It ~ Ta work tree's base commit is out-of-date
486 Delete the branch with the specified name from the repository.
487 Only the branch reference is deleted.
488 Any commit, tree, and blob objects belonging to the branch
489 remain in the repository and may be removed separately with
490 Git's garbage collector.
495 .It Cm add Ar file-path ...
496 Schedule unversioned files in a work tree for addition to the
497 repository in the next commit.
498 .It Cm remove Ar file-path ...
499 Remove versioned files from a work tree and schedule them for deletion
500 from the repository in the next commit.
507 Perform the operation even if a file contains uncommitted modifications.
512 .It Cm revert [ Fl p ] [ Fl F Ar response-script ] [ Fl R ] Ar path ...
513 Revert any uncommited changes in files at the specified paths.
514 File contents will be overwritten with those contained in the
515 work tree's base commit. There is no way to bring discarded
519 If a file was added with
521 it will become an unversioned file again.
522 If a file was deleted with
531 Instead of reverting all changes in files, interactively select or reject
532 changes to revert based on
538 (quit reverting this file) responses.
539 If a file is in modified status, individual patches derived from the
540 modified file content can be reverted.
541 Files in added or deleted status may only be reverted in their entirety.
542 .It Fl F Ar response-script
550 responses line-by-line from the specified
552 file instead of prompting interactively.
554 Permit recursion into directories.
555 If this option is not specified,
557 will refuse to run if a specified
564 .It Cm commit [ Fl m Ar message ] [ path ... ]
565 Create a new commit in the repository from changes in a work tree
566 and use this commit as the new base commit for the work tree.
569 is specified, commit all changes in the work tree.
570 Otherwise, commit changes at or within the specified paths.
572 If changes have been explicitly staged for commit with
574 only commit staged changes and reject any specified paths which
575 have not been staged.
577 Show the status of each affected file, using the following status codes:
578 .Bl -column YXZ description
579 .It M Ta modified file
580 .It D Ta file was deleted
581 .It A Ta new file was added
584 Files which are not part of the new commit will retain their previously
585 recorded base commit.
588 commands may refuse to run while the work tree contains files from
589 multiple base commits.
590 The base commit of such a work tree can be made consistent by running
592 across the entire work tree.
598 environment variable to be set.
605 Use the specified log message when creating the new commit.
610 opens a temporary file in an editor where a log message can be written.
614 will refuse to run if certain preconditions are not met.
615 If the work tree's current branch is not in the
617 reference namespace, new commits may not be created on this branch.
618 Local changes may only be committed if they are based on file content
619 found in the most recent commit on the work tree's branch.
620 If a path is found to be out of date,
622 must be used first in order to merge local changes with changes made
627 .It Cm cherrypick Ar commit
628 Merge changes from a single
633 must be on a different branch than the work tree's base commit.
634 The expected argument is a reference or a commit ID SHA1 hash.
635 An abbreviated hash argument will be expanded to a full SHA1 hash
636 automatically, provided the abbreviation is unique.
638 Show the status of each affected file, using the following status codes:
639 .Bl -column YXZ description
640 .It G Ta file was merged
641 .It C Ta file was merged and conflicts occurred during merge
642 .It ! Ta changes destined for a missing file were not merged
643 .It D Ta file was deleted
644 .It d Ta file's deletion was obstructed by local modifications
645 .It A Ta new file was added
646 .It ~ Ta changes destined for a non-regular file were not merged
649 The merged changes will appear as local changes in the work tree, which
652 amended manually or with further
657 or discarded again with
661 will refuse to run if certain preconditions are not met.
662 If the work tree contains multiple base commits it must first be updated
663 to a single base commit with
665 If the work tree already contains files with merge conflicts, these
666 conflicts must be resolved first.
670 .It Cm backout Ar commit
671 Reverse-merge changes from a single
676 must be on the same branch as the work tree's base commit.
677 The expected argument is a reference or a commit ID SHA1 hash.
678 An abbreviated hash argument will be expanded to a full SHA1 hash
679 automatically, provided the abbreviation is unique.
681 Show the status of each affected file, using the following status codes:
682 .Bl -column YXZ description
683 .It G Ta file was merged
684 .It C Ta file was merged and conflicts occurred during merge
685 .It ! Ta changes destined for a missing file were not merged
686 .It D Ta file was deleted
687 .It d Ta file's deletion was obstructed by local modifications
688 .It A Ta new file was added
689 .It ~ Ta changes destined for a non-regular file were not merged
692 The reverse-merged changes will appear as local changes in the work tree,
693 which may be viewed with
695 amended manually or with further
700 or discarded again with
704 will refuse to run if certain preconditions are not met.
705 If the work tree contains multiple base commits it must first be updated
706 to a single base commit with
708 If the work tree already contains files with merge conflicts, these
709 conflicts must be resolved first.
713 .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
714 Rebase commits on the specified
716 onto the tip of the current branch of the work tree.
719 must share common ancestry with the work tree's current branch.
720 Rebasing begins with the first descendent commit of the youngest
721 common ancestor commit shared by the specified
723 and the work tree's current branch, and stops once the tip commit
728 Rebased commits are accumulated on a temporary branch which the work tree
729 will remain switched to throughout the entire rebase operation.
730 Commits on this branch represent the same changes with the same log
731 messages as their counterparts on the original
733 but with different commit IDs.
734 Once rebasing has completed successfully, the temporary branch becomes
735 the new version of the specified
737 and the work tree is automatically switched to it.
739 While rebasing commits, show the status of each affected file,
740 using the following status codes:
741 .Bl -column YXZ description
742 .It G Ta file was merged
743 .It C Ta file was merged and conflicts occurred during merge
744 .It ! Ta changes destined for a missing file were not merged
745 .It D Ta file was deleted
746 .It d Ta file's deletion was obstructed by local modifications
747 .It A Ta new file was added
748 .It ~ Ta changes destined for a non-regular file were not merged
751 If merge conflicts occur the rebase operation is interrupted and may
752 be continued once conflicts have been resolved.
753 Alternatively, the rebase operation may be aborted which will leave
755 unmodified and the work tree switched back to its original branch.
757 If a merge conflict is resolved in a way which renders the merged
758 change into a no-op change, the corresponding commit will be elided
759 when the rebase operation continues.
762 will refuse to run if certain preconditions are not met.
763 If the work tree contains multiple base commits it must first be updated
764 to a single base commit with
766 If changes have been staged with
768 these changes must first be comitted with
772 If the work tree contains local changes, these changes must first be
779 contains changes to files outside of the work tree's path prefix,
780 the work tree cannot be used to rebase this branch.
786 commands will refuse to run while a rebase operation is in progress.
787 Other commands which manipulate the work tree may be used for
788 conflict resolution purposes.
795 Abort an interrupted rebase operation.
796 If this option is used, no further command-line arguments are allowed.
798 Continue an interrupted rebase operation.
799 If this option is used, no further command-line arguments are allowed.
804 .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
805 Edit commit history between the work tree's current base commit and
806 the tip commit of the work tree's current branch.
808 Editing of commit history is controlled via a
810 which can be edited interactively or passed on the command line.
811 The format of the histedit script is line-based.
812 Each line in the script begins with a command name, followed by
813 whitespace and an argument.
814 For most commands, the expected argument is a commit ID SHA1 hash.
815 Any remaining text on the line is ignored.
816 Lines which begin with the
818 character are ignored entirely.
820 The available commands are as follows:
821 .Bl -column YXZ pick-commit
822 .It pick Ar commit Ta Use the specified commit as it is.
823 .It edit Ar commit Ta Use the specified commit but once changes have been
824 merged into the work tree interrupt the histedit operation for amending.
825 .It fold Ar commit Ta Combine the specified commit with the next commit
826 listed further below that will be used.
827 .It drop Ar commit Ta Remove this commit from the edited history.
828 .It mesg Ar log-message Ta Use the specified single-line log message for
829 the commit on the previous line.
830 If the log message argument is left empty, open an editor where a new
831 log message can be written.
834 Every commit in the history being edited must be mentioned in the script.
835 Lines may be re-ordered to change the order of commits in the edited history.
837 Edited commits are accumulated on a temporary branch which the work tree
838 will remain switched to throughout the entire histedit operation.
839 Once history editing has completed successfully, the temporary branch becomes
840 the new version of the work tree's branch and the work tree is automatically
843 While merging commits, show the status of each affected file,
844 using the following status codes:
845 .Bl -column YXZ description
846 .It G Ta file was merged
847 .It C Ta file was merged and conflicts occurred during merge
848 .It ! Ta changes destined for a missing file were not merged
849 .It D Ta file was deleted
850 .It d Ta file's deletion was obstructed by local modifications
851 .It A Ta new file was added
852 .It ~ Ta changes destined for a non-regular file were not merged
855 If merge conflicts occur the histedit operation is interrupted and may
856 be continued once conflicts have been resolved.
857 Alternatively, the histedit operation may be aborted which will leave
858 the work tree switched back to its original branch.
860 If a merge conflict is resolved in a way which renders the merged
861 change into a no-op change, the corresponding commit will be elided
862 when the histedit operation continues.
865 will refuse to run if certain preconditions are not met.
866 If the work tree's current branch is not in the
868 reference namespace, the history of the branch may not be edited.
869 If the work tree contains multiple base commits it must first be updated
870 to a single base commit with
872 If changes have been staged with
874 these changes must first be comitted with
878 If the work tree contains local changes, these changes must first be
883 If the edited history contains changes to files outside of the work tree's
884 path prefix, the work tree cannot be used to edit the history of this branch.
888 command will refuse to run while a histedit operation is in progress.
889 Other commands which manipulate the work tree may be used, and the
891 command may be used to commit arbitrary changes to the temporary branch
892 while the histedit operation is interrupted.
899 Abort an interrupted histedit operation.
900 If this option is used, no further command-line arguments are allowed.
902 Continue an interrupted histedit operation.
903 If this option is used, no further command-line arguments are allowed.
908 .It Cm stage [ Fl l ] [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
909 Stage local changes for inclusion in the next commit.
912 is specified, stage all changes in the work tree.
913 Otherwise, stage changes at or within the specified paths.
914 Paths may be staged if they are added, modified, or deleted according to
917 Show the status of each affected file, using the following status codes:
918 .Bl -column YXZ description
919 .It A Ta file addition has been staged
920 .It M Ta file modification has been staged
921 .It D Ta file deletion has been staged
924 Staged file contents are saved in newly created blob objects in the repository.
925 These blobs will be referred to by tree objects once staged changes have been
928 Staged changes affect the behaviour of
933 While paths with staged changes exist, the
935 command will refuse to commit any paths which do not have staged changes.
936 Local changes created on top of staged changes can only be committed if
937 the path is staged again, or if the staged changes are committed first.
940 command will show both local changes and staged changes.
943 command is able to display local changes relative to staged changes,
944 and to display staged changes relative to the repository.
947 command cannot revert staged changes but may be used to revert
948 local changes created on top of staged changes.
955 Instead of staging new changes, list paths which are already staged,
956 along with the IDs of staged blob objects and stage status codes.
957 If paths were provided in the command line show the staged paths
958 among the specified paths. Otherwise, show all staged paths.
960 Instead of staging the entire content of a changed file, interactively
961 select or reject changes for staging based on
967 (quit staging this file) responses.
968 If a file is in modified status, individual patches derived from the
969 modified file content can be staged.
970 Files in added or deleted status may only be staged or rejected in
972 .It Fl F Ar response-script
980 responses line-by-line from the specified
982 file instead of prompting interactively.
986 will refuse to run if certain preconditions are not met.
987 If a file contains merge conflicts, these conflicts must be resolved first.
988 If a file is found to be out of date relative to the head commit on the
989 work tree's current branch, the file must be updated with
991 before it can be staged (however, this does not prevent the file from
992 becoming out-of-date at some point after having been staged).
999 commands will refuse to run while staged changes exist.
1000 If staged changes cannot be committed because a staged path
1001 is out of date, the path must be unstaged with
1003 before it can be updated with
1005 and may then be staged again if necessary.
1009 .It Cm unstage [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
1010 Merge staged changes back into the work tree and put affected paths
1011 back into non-staged status.
1014 is specified, unstage all staged changes across the entire work tree.
1015 Otherwise, unstage changes at or within the specified paths.
1017 Show the status of each affected file, using the following status codes:
1018 .Bl -column YXZ description
1019 .It G Ta file was unstaged
1020 .It C Ta file was unstaged and conflicts occurred during merge
1021 .It ! Ta changes destined for a missing file were not merged
1022 .It D Ta file was staged as deleted and still is deleted
1023 .It d Ta file's deletion was obstructed by local modifications
1024 .It ~ Ta changes destined for a non-regular file were not merged
1032 Instead of unstaging the entire content of a changed file, interactively
1033 select or reject changes for unstaging based on
1037 (keep change staged), and
1039 (quit unstaging this file) responses.
1040 If a file is staged in modified status, individual patches derived from the
1041 staged file content can be unstaged.
1042 Files staged in added or deleted status may only be unstaged in their entirety.
1043 .It Fl F Ar response-script
1051 responses line-by-line from the specified
1053 file instead of prompting interactively.
1060 .Bl -tag -width GOT_AUTHOR
1062 The author's name and email address for
1067 .An Flan Hacker Aq Mt flan_hacker@openbsd.org
1068 .It Ev VISUAL, Ev EDITOR
1069 The editor spawned by
1075 Clone an existing Git repository for use with
1077 This step currently requires
1081 .Dl $ git clone --bare https://github.com/openbsd/src.git
1083 Alternatively, for quick and dirty local testing of
1085 a new Git repository could be created and populated with files,
1086 e.g. from a temporary CVS checkout located at
1089 .Dl $ got init /var/git/src.git
1090 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1092 Check out a work tree from the Git repository to /usr/src:
1094 .Dl $ got checkout /var/git/src.git /usr/src
1096 View local changes in a work tree directory:
1099 .Dl $ got diff | less
1101 Interactively revert selected local changes in a work tree directory:
1103 .Dl $ got revert -p -R\ .
1105 In a work tree or a git repository directory, list all branch references:
1109 In a work tree or a git repository directory, create a new branch called
1110 .Dq unified-buffer-cache
1111 which is forked off the
1115 .Dl $ got branch unified-buffer-cache master
1117 Switch an existing work tree to the branch
1118 .Dq unified-buffer-cache .
1119 Local changes in the work tree will be preserved and merged if necessary:
1121 .Dl $ got update -b unified-buffer-cache
1123 Create a new commit from local changes in a work tree directory.
1124 This new commit will become the head commit of the work tree's current branch:
1128 In a work tree or a git repository directory, view changes committed in
1129 the 3 most recent commits to the work tree's branch, or the branch resolved
1130 via the repository's HEAD reference, respectively:
1132 .Dl $ got log -p -l 3 -f
1134 Add new files and remove obsolete files in a work tree directory:
1136 .Dl $ got add sys/uvm/uvm_ubc.c
1137 .Dl $ got remove sys/uvm/uvm_vnode.c
1139 Create a new commit from local changes in a work tree directory
1140 with a pre-defined log message.
1142 .Dl $ got commit -m 'unify the buffer cache'
1144 Update any work tree checked out from the
1145 .Dq unified-buffer-cache
1146 branch to the latest commit on this branch:
1150 Roll file content on the unified-buffer-cache branch back by one commit,
1151 and then fetch the rolled-back change into the work tree as a local change
1152 to be amended and perhaps committed again:
1154 .Dl $ got backout unified-buffer-cache
1155 .Dl $ got commit -m 'roll back previous'
1156 .Dl $ # now back out the previous backout :-)
1157 .Dl $ got backout unified-buffer-cache
1159 Fetch new upstream commits into the local repository's master branch.
1160 This step currently requires
1163 .Dl $ cd /var/git/src.git
1164 .Dl $ git fetch origin master:master
1167 .Dq unified-buffer-cache
1168 branch on top of the new head commit of the
1172 .Dl $ got update -b master
1173 .Dl $ got rebase unified-buffer-cache
1175 Create a patch from all changes on the unified-buffer-cache branch.
1176 The patch can be mailed out for review and applied to OpenBSD's CVS tree:
1178 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1180 Edit the entire commit history of the
1181 .Dq unified-buffer-cache
1184 .Dl $ got update -b unified-buffer-cache
1185 .Dl $ got update -c master
1188 Additional steps are necessary if local changes need to be pushed back
1189 to the remote repository, which currently requires
1193 Before working against existing branches in a repository cloned with
1194 .Dq git clone --bare ,
1197 must be configured to map all references in the remote repository
1200 namespace of the local repository.
1201 This can achieved by setting Git's
1202 .Pa remote.origin.fetch
1203 configuration variable to the value
1204 .Dq +refs/heads/*:refs/remotes/origin/*
1209 .Dl $ cd /var/git/repo
1210 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1212 Alternatively, the following
1214 configuration item can be added manually to the Git repository's
1218 .Dl [remote "origin"]
1220 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1222 This configuration leaves the local repository's
1224 namespace free for use by local branches checked out with
1226 and, if needed, created with
1231 namespace can be updated with incoming changes from the remote
1235 .Dl $ cd /var/git/repo
1238 Before outgoing changes on the local
1240 branch can be pushed to the remote repository, the local
1242 branch must be rebased onto the
1246 .Dl $ got update -b origin/master
1247 .Dl $ got rebase master
1249 Changes on the local
1251 branch can then be pushed to the remote
1255 .Dl $ cd /var/git/repo
1256 .Dl $ git push origin master
1260 .Xr git-repository 5 ,
1263 .An Stefan Sperling Aq Mt stsp@openbsd.org
1264 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1265 .An joshua stein Aq Mt jcs@openbsd.org
1268 is a work-in-progress and many commands remain to be implemented.
1269 At present, the user has to fall back on
1271 to perform many tasks, in particular tasks related to repository
1272 administration and tasks which require a network connection.
