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 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 Permit recursion into directories.
532 If this option is not specified,
534 will refuse to run if a specified
541 .It Cm commit [ Fl m Ar message ] [ path ... ]
542 Create a new commit in the repository from changes in a work tree
543 and use this commit as the new base commit for the work tree.
546 is specified, commit all changes in the work tree.
547 Otherwise, commit changes at or within the specified paths.
549 If changes have been explicitly staged for commit with
551 only commit staged changes and reject any specified paths which
552 have not been staged.
554 Show the status of each affected file, using the following status codes:
555 .Bl -column YXZ description
556 .It M Ta modified file
557 .It D Ta file was deleted
558 .It A Ta new file was added
561 Files which are not part of the new commit will retain their previously
562 recorded base commit.
565 commands may refuse to run while the work tree contains files from
566 multiple base commits.
567 The base commit of such a work tree can be made consistent by running
569 across the entire work tree.
575 environment variable to be set.
582 Use the specified log message when creating the new commit.
587 opens a temporary file in an editor where a log message can be written.
591 will refuse to run if certain preconditions are not met.
592 If the work tree's current branch is not in the
594 reference namespace, new commits may not be created on this branch.
595 Local changes may only be committed if they are based on file content
596 found in the most recent commit on the work tree's branch.
597 If a path is found to be out of date,
599 must be used first in order to merge local changes with changes made
604 .It Cm cherrypick Ar commit
605 Merge changes from a single
610 must be on a different branch than the work tree's base commit.
611 The expected argument is a reference or a commit ID SHA1 hash.
612 An abbreviated hash argument will be expanded to a full SHA1 hash
613 automatically, provided the abbreviation is unique.
615 Show the status of each affected file, using the following status codes:
616 .Bl -column YXZ description
617 .It G Ta file was merged
618 .It C Ta file was merged and conflicts occurred during merge
619 .It ! Ta changes destined for a missing file were not merged
620 .It D Ta file was deleted
621 .It d Ta file's deletion was obstructed by local modifications
622 .It A Ta new file was added
623 .It ~ Ta changes destined for a non-regular file were not merged
626 The merged changes will appear as local changes in the work tree, which
629 amended manually or with further
634 or discarded again with
638 will refuse to run if certain preconditions are not met.
639 If the work tree contains multiple base commits it must first be updated
640 to a single base commit with
642 If the work tree already contains files with merge conflicts, these
643 conflicts must be resolved first.
647 .It Cm backout Ar commit
648 Reverse-merge changes from a single
653 must be on the same branch as the work tree's base commit.
654 The expected argument is a reference or a commit ID SHA1 hash.
655 An abbreviated hash argument will be expanded to a full SHA1 hash
656 automatically, provided the abbreviation is unique.
658 Show the status of each affected file, using the following status codes:
659 .Bl -column YXZ description
660 .It G Ta file was merged
661 .It C Ta file was merged and conflicts occurred during merge
662 .It ! Ta changes destined for a missing file were not merged
663 .It D Ta file was deleted
664 .It d Ta file's deletion was obstructed by local modifications
665 .It A Ta new file was added
666 .It ~ Ta changes destined for a non-regular file were not merged
669 The reverse-merged changes will appear as local changes in the work tree,
670 which may be viewed with
672 amended manually or with further
677 or discarded again with
681 will refuse to run if certain preconditions are not met.
682 If the work tree contains multiple base commits it must first be updated
683 to a single base commit with
685 If the work tree already contains files with merge conflicts, these
686 conflicts must be resolved first.
690 .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
691 Rebase commits on the specified
693 onto the tip of the current branch of the work tree.
696 must share common ancestry with the work tree's current branch.
697 Rebasing begins with the first descendent commit of the youngest
698 common ancestor commit shared by the specified
700 and the work tree's current branch, and stops once the tip commit
705 Rebased commits are accumulated on a temporary branch which the work tree
706 will remain switched to throughout the entire rebase operation.
707 Commits on this branch represent the same changes with the same log
708 messages as their counterparts on the original
710 but with different commit IDs.
711 Once rebasing has completed successfully, the temporary branch becomes
712 the new version of the specified
714 and the work tree is automatically switched to it.
716 While rebasing commits, show the status of each affected file,
717 using the following status codes:
718 .Bl -column YXZ description
719 .It G Ta file was merged
720 .It C Ta file was merged and conflicts occurred during merge
721 .It ! Ta changes destined for a missing file were not merged
722 .It D Ta file was deleted
723 .It d Ta file's deletion was obstructed by local modifications
724 .It A Ta new file was added
725 .It ~ Ta changes destined for a non-regular file were not merged
728 If merge conflicts occur the rebase operation is interrupted and may
729 be continued once conflicts have been resolved.
730 Alternatively, the rebase operation may be aborted which will leave
732 unmodified and the work tree switched back to its original branch.
734 If a merge conflict is resolved in a way which renders the merged
735 change into a no-op change, the corresponding commit will be elided
736 when the rebase operation continues.
739 will refuse to run if certain preconditions are not met.
740 If the work tree contains multiple base commits it must first be updated
741 to a single base commit with
743 If changes have been staged with
745 these changes must first be comitted with
749 If the work tree contains local changes, these changes must first be
756 contains changes to files outside of the work tree's path prefix,
757 the work tree cannot be used to rebase this branch.
763 commands will refuse to run while a rebase operation is in progress.
764 Other commands which manipulate the work tree may be used for
765 conflict resolution purposes.
772 Abort an interrupted rebase operation.
773 If this option is used, no further command-line arguments are allowed.
775 Continue an interrupted rebase operation.
776 If this option is used, no further command-line arguments are allowed.
781 .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
782 Edit commit history between the work tree's current base commit and
783 the tip commit of the work tree's current branch.
785 Editing of commit history is controlled via a
787 which can be edited interactively or passed on the command line.
788 The format of the histedit script is line-based.
789 Each line in the script begins with a command name, followed by
790 whitespace and an argument.
791 For most commands, the expected argument is a commit ID SHA1 hash.
792 Any remaining text on the line is ignored.
793 Lines which begin with the
795 character are ignored entirely.
797 The available commands are as follows:
798 .Bl -column YXZ pick-commit
799 .It pick Ar commit Ta Use the specified commit as it is.
800 .It edit Ar commit Ta Use the specified commit but once changes have been
801 merged into the work tree interrupt the histedit operation for amending.
802 .It fold Ar commit Ta Combine the specified commit with the next commit
803 listed further below that will be used.
804 .It drop Ar commit Ta Remove this commit from the edited history.
805 .It mesg Ar log-message Ta Use the specified single-line log message for
806 the commit on the previous line.
807 If the log message argument is left empty, open an editor where a new
808 log message can be written.
811 Every commit in the history being edited must be mentioned in the script.
812 Lines may be re-ordered to change the order of commits in the edited history.
814 Edited commits are accumulated on a temporary branch which the work tree
815 will remain switched to throughout the entire histedit operation.
816 Once history editing has completed successfully, the temporary branch becomes
817 the new version of the work tree's branch and the work tree is automatically
820 While merging commits, show the status of each affected file,
821 using the following status codes:
822 .Bl -column YXZ description
823 .It G Ta file was merged
824 .It C Ta file was merged and conflicts occurred during merge
825 .It ! Ta changes destined for a missing file were not merged
826 .It D Ta file was deleted
827 .It d Ta file's deletion was obstructed by local modifications
828 .It A Ta new file was added
829 .It ~ Ta changes destined for a non-regular file were not merged
832 If merge conflicts occur the histedit operation is interrupted and may
833 be continued once conflicts have been resolved.
834 Alternatively, the histedit operation may be aborted which will leave
835 the work tree switched back to its original branch.
837 If a merge conflict is resolved in a way which renders the merged
838 change into a no-op change, the corresponding commit will be elided
839 when the histedit operation continues.
842 will refuse to run if certain preconditions are not met.
843 If the work tree's current branch is not in the
845 reference namespace, the history of the branch may not be edited.
846 If the work tree contains multiple base commits it must first be updated
847 to a single base commit with
849 If changes have been staged with
851 these changes must first be comitted with
855 If the work tree contains local changes, these changes must first be
860 If the edited history contains changes to files outside of the work tree's
861 path prefix, the work tree cannot be used to edit the history of this branch.
865 command will refuse to run while a histedit operation is in progress.
866 Other commands which manipulate the work tree may be used, and the
868 command may be used to commit arbitrary changes to the temporary branch
869 while the histedit operation is interrupted.
876 Abort an interrupted histedit operation.
877 If this option is used, no further command-line arguments are allowed.
879 Continue an interrupted histedit operation.
880 If this option is used, no further command-line arguments are allowed.
885 .It Cm stage [ Fl l ] [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
886 Stage local changes for inclusion in the next commit.
889 is specified, stage all changes in the work tree.
890 Otherwise, stage changes at or within the specified paths.
891 Paths may be staged if they are added, modified, or deleted according to
894 Show the status of each affected file, using the following status codes:
895 .Bl -column YXZ description
896 .It A Ta file addition has been staged
897 .It M Ta file modification has been staged
898 .It D Ta file deletion has been staged
901 Staged file contents are saved in newly created blob objects in the repository.
902 These blobs will be referred to by tree objects once staged changes have been
905 Staged changes affect the behaviour of
910 While paths with staged changes exist, the
912 command will refuse to commit any paths which do not have staged changes.
913 Local changes created on top of staged changes can only be committed if
914 the path is staged again, or if the staged changes are committed first.
917 command will show both local changes and staged changes.
920 command is able to display local changes relative to staged changes,
921 and to display staged changes relative to the repository.
924 command cannot revert staged changes but may be used to revert
925 local changes created on top of staged changes.
932 Instead of staging new changes, list paths which are already staged,
933 along with the IDs of staged blob objects and stage status codes.
934 If paths were provided in the command line show the staged paths
935 among the specified paths. Otherwise, show all staged paths.
937 Instead of staging the entire content of a changed file, interactively
938 select or reject changes for staging based on
944 (quit staging this file) responses.
945 If a file is in modified status, individual patches derived from the
946 modified file content can be staged.
947 Files in added or deleted status may only be staged or rejected in
949 .It Fl F Ar response-script
957 responses line-by-line from the specified
959 file instead of prompting interactively.
963 will refuse to run if certain preconditions are not met.
964 If a file contains merge conflicts, these conflicts must be resolved first.
965 If a file is found to be out of date relative to the head commit on the
966 work tree's current branch, the file must be updated with
968 before it can be staged (however, this does not prevent the file from
969 becoming out-of-date at some point after having been staged).
976 commands will refuse to run while staged changes exist.
977 If staged changes cannot be committed because a staged path
978 is out of date, the path must be unstaged with
980 before it can be updated with
982 and may then be staged again if necessary.
986 .It Cm unstage [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
987 Merge staged changes back into the work tree and put affected paths
988 back into non-staged status.
991 is specified, unstage all staged changes across the entire work tree.
992 Otherwise, unstage changes at or within the specified paths.
994 Show the status of each affected file, using the following status codes:
995 .Bl -column YXZ description
996 .It G Ta file was unstaged
997 .It C Ta file was unstaged and conflicts occurred during merge
998 .It ! Ta changes destined for a missing file were not merged
999 .It D Ta file was staged as deleted and still is deleted
1000 .It d Ta file's deletion was obstructed by local modifications
1001 .It ~ Ta changes destined for a non-regular file were not merged
1009 Instead of unstaging the entire content of a changed file, interactively
1010 select or reject changes for unstaging based on
1014 (keep change staged), and
1016 (quit unstaging this file) responses.
1017 If a file is staged in modified status, individual patches derived from the
1018 staged file content can be unstaged.
1019 Files staged in added or deleted status may only be unstaged in their entirety.
1020 .It Fl F Ar response-script
1028 responses line-by-line from the specified
1030 file instead of prompting interactively.
1037 .Bl -tag -width GOT_AUTHOR
1039 The author's name and email address for
1044 .An Flan Hacker Aq Mt flan_hacker@openbsd.org
1045 .It Ev VISUAL, Ev EDITOR
1046 The editor spawned by
1052 Clone an existing Git repository for use with
1054 This step currently requires
1058 .Dl $ git clone --bare https://github.com/openbsd/src.git
1060 Alternatively, for quick and dirty local testing of
1062 a new Git repository could be created and populated with files,
1063 e.g. from a temporary CVS checkout located at
1066 .Dl $ got init /var/git/src.git
1067 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1069 Check out a work tree from the Git repository to /usr/src:
1071 .Dl $ got checkout /var/git/src.git /usr/src
1073 View local changes in a work tree directory:
1076 .Dl $ got diff | less
1078 In a work tree or a git repository directory, list all branch references:
1082 In a work tree or a git repository directory, create a new branch called
1083 .Dq unified-buffer-cache
1084 which is forked off the
1088 .Dl $ got branch unified-buffer-cache master
1090 Switch an existing work tree to the branch
1091 .Dq unified-buffer-cache .
1092 Local changes in the work tree will be preserved and merged if necessary:
1094 .Dl $ got update -b unified-buffer-cache
1096 Create a new commit from local changes in a work tree directory.
1097 This new commit will become the head commit of the work tree's current branch:
1101 In a work tree or a git repository directory, view changes committed in
1102 the 3 most recent commits to the work tree's branch, or the branch resolved
1103 via the repository's HEAD reference, respectively:
1105 .Dl $ got log -p -l 3 -f
1107 Add new files and remove obsolete files in a work tree directory:
1109 .Dl $ got add sys/uvm/uvm_ubc.c
1110 .Dl $ got remove sys/uvm/uvm_vnode.c
1112 Create a new commit from local changes in a work tree directory
1113 with a pre-defined log message.
1115 .Dl $ got commit -m 'unify the buffer cache'
1117 Update any work tree checked out from the
1118 .Dq unified-buffer-cache
1119 branch to the latest commit on this branch:
1123 Roll file content on the unified-buffer-cache branch back by one commit,
1124 and then fetch the rolled-back change into the work tree as a local change
1125 to be amended and perhaps committed again:
1127 .Dl $ got backout unified-buffer-cache
1128 .Dl $ got commit -m 'roll back previous'
1129 .Dl $ # now back out the previous backout :-)
1130 .Dl $ got backout unified-buffer-cache
1132 Fetch new upstream commits into the local repository's master branch.
1133 This step currently requires
1136 .Dl $ cd /var/git/src.git
1137 .Dl $ git fetch origin master:master
1140 .Dq unified-buffer-cache
1141 branch on top of the new head commit of the
1145 .Dl $ got update -b master
1146 .Dl $ got rebase unified-buffer-cache
1148 Create a patch from all changes on the unified-buffer-cache branch.
1149 The patch can be mailed out for review and applied to OpenBSD's CVS tree:
1151 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1153 Edit the entire commit history of the
1154 .Dq unified-buffer-cache
1157 .Dl $ got update -b unified-buffer-cache
1158 .Dl $ got update -c master
1161 Additional steps are necessary if local changes need to be pushed back
1162 to the remote repository, which currently requires
1166 Before working against existing branches in a repository cloned with
1167 .Dq git clone --bare ,
1170 must be configured to map all references in the remote repository
1173 namespace of the local repository.
1174 This can achieved by setting Git's
1175 .Pa remote.origin.fetch
1176 configuration variable to the value
1177 .Dq +refs/heads/*:refs/remotes/origin/*
1182 .Dl $ cd /var/git/repo
1183 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1185 Alternatively, the following
1187 configuration item can be added manually to the Git repository's
1191 .Dl [remote "origin"]
1193 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1195 This configuration leaves the local repository's
1197 namespace free for use by local branches checked out with
1199 and, if needed, created with
1204 namespace can be updated with incoming changes from the remote
1208 .Dl $ cd /var/git/repo
1211 Before outgoing changes on the local
1213 branch can be pushed to the remote repository, the local
1215 branch must be rebased onto the
1219 .Dl $ got update -b origin/master
1220 .Dl $ got rebase master
1222 Changes on the local
1224 branch can then be pushed to the remote
1228 .Dl $ cd /var/git/repo
1229 .Dl $ git push origin master
1233 .Xr git-repository 5 ,
1236 .An Stefan Sperling Aq Mt stsp@openbsd.org
1237 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1238 .An joshua stein Aq Mt jcs@openbsd.org
1241 is a work-in-progress and many commands remain to be implemented.
1242 At present, the user has to fall back on
1244 to perform many tasks, in particular tasks related to repository
1245 administration and tasks which require a network connection.
