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 If a path has staged changes, modification status of files shown
265 in the first output column is relative to the staged changes:
266 .Bl -column YXZ description
267 .It MM Ta modified file was modified again after being staged
268 .It MA Ta added file was modified after being staged
273 .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 ]
274 Display history of a repository.
277 is specified, show only commits which modified this path.
284 Start traversing history at the specified
286 The expected argument is a commit ID SHA1 hash or an existing reference
287 which will be resolved to a commit ID.
288 An abbreviated hash argument will be expanded to a full SHA1 hash
289 automatically, provided the abbreviation is unique.
290 If this option is not specified, default to the work tree's current branch
291 if invoked in a work tree, or to the repository's HEAD reference.
293 Set the number of context lines shown in diffs with
295 By default, 3 lines of context are shown.
297 Restrict history traversal to the first parent of each commit.
298 This shows the linear history of the current branch only.
299 Merge commits which affected the current branch will be shown but
300 individual commits which originated on other branches will be omitted.
302 Limit history traversal to a given number of commits.
304 Display the patch of modifications made in each commit.
305 .It Fl r Ar repository-path
306 Use the repository at the specified path.
307 If not specified, assume the repository is located at or above the current
309 If this directory is a
311 work tree, use the repository path associated with this work tree.
313 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Fl s ] [ Ar object1 Ar object2 | Ar path ]
314 When invoked within a work tree with less than two arguments, display
315 uncommitted changes in the work tree.
318 is specified, only show changes within this path.
320 If two arguments are provided, treat each argument as a reference,
321 or an object ID SHA1 hash, and display differences between these objects.
322 Both objects must be of the same type (blobs, trees, or commits).
323 An abbreviated hash argument will be expanded to a full SHA1 hash
324 automatically, provided the abbreviation is unique.
331 Set the number of context lines shown in the diff.
332 By default, 3 lines of context are shown.
333 .It Fl r Ar repository-path
334 Use the repository at the specified path.
335 If not specified, assume the repository is located at or above the current
337 If this directory is a
339 work tree, use the repository path associated with this work tree.
341 Show changes staged with
343 instead of showing local changes.
344 This option is only valid when
346 is invoked in a work tree.
351 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
352 Display line-by-line history of a file at the specified path.
359 Start traversing history at the specified
361 The expected argument is a commit ID SHA1 hash or an existing reference
362 which will be resolved to a commit ID.
363 An abbreviated hash argument will be expanded to a full SHA1 hash
364 automatically, provided the abbreviation is unique.
365 .It Fl r Ar repository-path
366 Use the repository at the specified path.
367 If not specified, assume the repository is located at or above the current
369 If this directory is a
371 work tree, use the repository path associated with this work tree.
376 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
377 Display a listing of files and directories at the specified
378 directory path in the repository.
379 Entries shown in this listing may carry one of the following trailing
381 .Bl -column YXZ description
382 .It / Ta entry is a directory
383 .It * Ta entry is an executable file
388 is specified, list the repository path corresponding to the current
389 directory of the work tree, or the root directory of the repository
390 if there is no work tree.
397 List files and directories as they appear in the specified
399 The expected argument is a commit ID SHA1 hash or an existing reference
400 which will be resolved to a commit ID.
401 An abbreviated hash argument will be expanded to a full SHA1 hash
402 automatically, provided the abbreviation is unique.
403 .It Fl r Ar repository-path
404 Use the repository at the specified path.
405 If not specified, assume the repository is located at or above the current
407 If this directory is a
409 work tree, use the repository path associated with this work tree.
411 Show object IDs of files (blob objects) and directories (tree objects).
413 Recurse into sub-directories in the repository.
418 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
419 Manage references in a repository.
421 If no options are passed, expect two arguments and attempt to create,
422 or update, the reference with the given
424 and make it point at the given
426 The target may be an object ID SHA1 hash or an existing reference which
427 will be resolved to an object ID.
428 An abbreviated hash argument will be expanded to a full SHA1 hash
429 automatically, provided the abbreviation is unique.
435 .It Fl r Ar repository-path
436 Use the repository at the specified path.
437 If not specified, assume the repository is located at or above the current
439 If this directory is a
441 work tree, use the repository path associated with this work tree.
443 List all existing references in the repository.
445 Delete the reference with the specified name from the repository.
447 .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
448 Manage branches in a repository.
450 Branches are managed via references which live in the
455 command operates on references in this namespace only.
457 If no options are passed, expect one or two arguments and attempt to create
458 a branch with the given
460 and make it point at the given
464 is specified, default to the work tree's current branch if invoked in a
465 work tree, or to the repository's HEAD reference.
471 .It Fl r Ar repository-path
472 Use the repository at the specified path.
473 If not specified, assume the repository is located at or above the current
475 If this directory is a
477 work tree, use the repository path associated with this work tree.
479 List all existing branches in the repository.
480 If invoked in a work tree, the work tree's current branch is shown
481 with one the following annotations:
482 .Bl -column YXZ description
483 .It * Ta work tree's base commit matches the branch tip
484 .It ~ Ta work tree's base commit is out-of-date
487 Delete the branch with the specified name from the repository.
488 Only the branch reference is deleted.
489 Any commit, tree, and blob objects belonging to the branch
490 remain in the repository and may be removed separately with
491 Git's garbage collector.
496 .It Cm add Ar file-path ...
497 Schedule unversioned files in a work tree for addition to the
498 repository in the next commit.
499 .It Cm remove Ar file-path ...
500 Remove versioned files from a work tree and schedule them for deletion
501 from the repository in the next commit.
508 Perform the operation even if a file contains uncommitted modifications.
513 .It Cm revert Ar file-path ...
514 Revert any uncommited changes in files at the specified paths.
515 File contents will be overwritten with those contained in the
516 work tree's base commit. There is no way to bring discarded
520 If a file was added with
522 it will become an unversioned file again.
523 If a file was deleted with
529 .It Cm commit [ Fl m Ar message ] [ path ... ]
530 Create a new commit in the repository from changes in a work tree
531 and use this commit as the new base commit for the work tree.
534 is specified, commit all changes in the work tree.
535 Otherwise, commit changes at or within the specified paths.
537 If changes have been explicitly staged for commit with
539 only commit staged changes and reject any specified paths which
540 have not been staged.
542 Show the status of each affected file, using the following status codes:
543 .Bl -column YXZ description
544 .It M Ta modified file
545 .It D Ta file was deleted
546 .It A Ta new file was added
549 Files which are not part of the new commit will retain their previously
550 recorded base commit.
553 commands may refuse to run while the work tree contains files from
554 multiple base commits.
555 The base commit of such a work tree can be made consistent by running
557 across the entire work tree.
563 environment variable to be set.
570 Use the specified log message when creating the new commit.
575 opens a temporary file in an editor where a log message can be written.
579 will refuse to run if certain preconditions are not met.
580 If the work tree's current branch is not in the
582 reference namespace, new commits may not be created on this branch.
583 Local changes may only be committed if they are based on file content
584 found in the most recent commit on the work tree's branch.
585 If a path is found to be out of date,
587 must be used first in order to merge local changes with changes made
592 .It Cm cherrypick Ar commit
593 Merge changes from a single
598 must be on a different branch than the work tree's base commit.
599 The expected argument is a reference or a commit ID SHA1 hash.
600 An abbreviated hash argument will be expanded to a full SHA1 hash
601 automatically, provided the abbreviation is unique.
603 Show the status of each affected file, using the following status codes:
604 .Bl -column YXZ description
605 .It G Ta file was merged
606 .It C Ta file was merged and conflicts occurred during merge
607 .It ! Ta changes destined for a missing file were not merged
608 .It D Ta file was deleted
609 .It d Ta file's deletion was obstructed by local modifications
610 .It A Ta new file was added
611 .It ~ Ta changes destined for a non-regular file were not merged
614 The merged changes will appear as local changes in the work tree, which
617 amended manually or with further
622 or discarded again with
626 will refuse to run if certain preconditions are not met.
627 If the work tree contains multiple base commits it must first be updated
628 to a single base commit with
630 If the work tree already contains files with merge conflicts, these
631 conflicts must be resolved first.
635 .It Cm backout Ar commit
636 Reverse-merge changes from a single
641 must be on the same branch as the work tree's base commit.
642 The expected argument is a reference or a commit ID SHA1 hash.
643 An abbreviated hash argument will be expanded to a full SHA1 hash
644 automatically, provided the abbreviation is unique.
646 Show the status of each affected file, using the following status codes:
647 .Bl -column YXZ description
648 .It G Ta file was merged
649 .It C Ta file was merged and conflicts occurred during merge
650 .It ! Ta changes destined for a missing file were not merged
651 .It D Ta file was deleted
652 .It d Ta file's deletion was obstructed by local modifications
653 .It A Ta new file was added
654 .It ~ Ta changes destined for a non-regular file were not merged
657 The reverse-merged changes will appear as local changes in the work tree,
658 which may be viewed with
660 amended manually or with further
665 or discarded again with
669 will refuse to run if certain preconditions are not met.
670 If the work tree contains multiple base commits it must first be updated
671 to a single base commit with
673 If the work tree already contains files with merge conflicts, these
674 conflicts must be resolved first.
678 .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
679 Rebase commits on the specified
681 onto the tip of the current branch of the work tree.
684 must share common ancestry with the work tree's current branch.
685 Rebasing begins with the first descendent commit of the youngest
686 common ancestor commit shared by the specified
688 and the work tree's current branch, and stops once the tip commit
693 Rebased commits are accumulated on a temporary branch which the work tree
694 will remain switched to throughout the entire rebase operation.
695 Commits on this branch represent the same changes with the same log
696 messages as their counterparts on the original
698 but with different commit IDs.
699 Once rebasing has completed successfully, the temporary branch becomes
700 the new version of the specified
702 and the work tree is automatically switched to it.
704 While rebasing commits, show the status of each affected file,
705 using the following status codes:
706 .Bl -column YXZ description
707 .It G Ta file was merged
708 .It C Ta file was merged and conflicts occurred during merge
709 .It ! Ta changes destined for a missing file were not merged
710 .It D Ta file was deleted
711 .It d Ta file's deletion was obstructed by local modifications
712 .It A Ta new file was added
713 .It ~ Ta changes destined for a non-regular file were not merged
716 If merge conflicts occur the rebase operation is interrupted and may
717 be continued once conflicts have been resolved.
718 Alternatively, the rebase operation may be aborted which will leave
720 unmodified and the work tree switched back to its original branch.
722 If a merge conflict is resolved in a way which renders the merged
723 change into a no-op change, the corresponding commit will be elided
724 when the rebase operation continues.
727 will refuse to run if certain preconditions are not met.
728 If the work tree contains multiple base commits it must first be updated
729 to a single base commit with
731 If changes have been staged with
733 these changes must first be comitted with
737 If the work tree contains local changes, these changes must first be
744 contains changes to files outside of the work tree's path prefix,
745 the work tree cannot be used to rebase this branch.
751 commands will refuse to run while a rebase operation is in progress.
752 Other commands which manipulate the work tree may be used for
753 conflict resolution purposes.
760 Abort an interrupted rebase operation.
761 If this option is used, no further command-line arguments are allowed.
763 Continue an interrupted rebase operation.
764 If this option is used, no further command-line arguments are allowed.
769 .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
770 Edit commit history between the work tree's current base commit and
771 the tip commit of the work tree's current branch.
773 Editing of commit history is controlled via a
775 which can be edited interactively or passed on the command line.
776 The format of the histedit script is line-based.
777 Each line in the script begins with a command name, followed by
778 whitespace and an argument.
779 For most commands, the expected argument is a commit ID SHA1 hash.
780 Any remaining text on the line is ignored.
781 Lines which begin with the
783 character are ignored entirely.
785 The available commands are as follows:
786 .Bl -column YXZ pick-commit
787 .It pick Ar commit Ta Use the specified commit as it is.
788 .It edit Ar commit Ta Use the specified commit but once changes have been
789 merged into the work tree interrupt the histedit operation for amending.
790 .It fold Ar commit Ta Combine the specified commit with the next commit
791 listed further below that will be used.
792 .It drop Ar commit Ta Remove this commit from the edited history.
793 .It mesg Ar log-message Ta Use the specified single-line log message for
794 the commit on the previous line.
795 If the log message argument is left empty, open an editor where a new
796 log message can be written.
799 Every commit in the history being edited must be mentioned in the script.
800 Lines may be re-ordered to change the order of commits in the edited history.
802 Edited commits are accumulated on a temporary branch which the work tree
803 will remain switched to throughout the entire histedit operation.
804 Once history editing has completed successfully, the temporary branch becomes
805 the new version of the work tree's branch and the work tree is automatically
808 While merging commits, show the status of each affected file,
809 using the following status codes:
810 .Bl -column YXZ description
811 .It G Ta file was merged
812 .It C Ta file was merged and conflicts occurred during merge
813 .It ! Ta changes destined for a missing file were not merged
814 .It D Ta file was deleted
815 .It d Ta file's deletion was obstructed by local modifications
816 .It A Ta new file was added
817 .It ~ Ta changes destined for a non-regular file were not merged
820 If merge conflicts occur the histedit operation is interrupted and may
821 be continued once conflicts have been resolved.
822 Alternatively, the histedit operation may be aborted which will leave
823 the work tree switched back to its original branch.
825 If a merge conflict is resolved in a way which renders the merged
826 change into a no-op change, the corresponding commit will be elided
827 when the histedit operation continues.
830 will refuse to run if certain preconditions are not met.
831 If the work tree's current branch is not in the
833 reference namespace, the history of the branch may not be edited.
834 If the work tree contains multiple base commits it must first be updated
835 to a single base commit with
837 If changes have been staged with
839 these changes must first be comitted with
843 If the work tree contains local changes, these changes must first be
848 If the edited history contains changes to files outside of the work tree's
849 path prefix, the work tree cannot be used to edit the history of this branch.
853 command will refuse to run while a histedit operation is in progress.
854 Other commands which manipulate the work tree may be used, and the
856 command may be used to commit arbitrary changes to the temporary branch
857 while the histedit operation is interrupted.
864 Abort an interrupted histedit operation.
865 If this option is used, no further command-line arguments are allowed.
867 Continue an interrupted histedit operation.
868 If this option is used, no further command-line arguments are allowed.
873 .It Cm stage [ Fl l ] [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
874 Stage local changes for inclusion in the next commit.
877 is specified, stage all changes in the work tree.
878 Otherwise, stage changes at or within the specified paths.
879 Paths may be staged if they are added, modified, or deleted according to
882 Show the status of each affected file, using the following status codes:
883 .Bl -column YXZ description
884 .It A Ta file addition has been staged
885 .It M Ta file modification has been staged
886 .It D Ta file deletion has been staged
889 Staged file contents are saved in newly created blob objects in the repository.
890 These blobs will be referred to by tree objects once staged changes have been
893 Staged changes affect the behaviour of
898 While paths with staged changes exist, the
900 command will refuse to commit any paths which do not have staged changes.
901 Local changes created on top of staged changes can only be committed if
902 the path is staged again, or if the staged changes are committed first.
905 command will show both local changes and staged changes.
908 command is able to display local changes relative to staged changes,
909 and to display staged changes relative to the repository.
912 command cannot revert staged changes but may be used to revert
913 local changes created on top of staged changes.
920 Instead of staging new changes, list paths which are already staged,
921 along with the IDs of staged blob objects and stage status codes.
922 If paths were provided in the command line show the staged paths
923 among the specified paths. Otherwise, show all staged paths.
925 Instead of staging the entire content of a changed file, interactively
926 select or reject changes for staging based on
932 (quit staging this file) responses.
933 If a file is in modified status, individual patches derived from the
934 modified file content can be staged.
935 Files in added or deleted status may only be staged or rejected in
937 .It Fl F Ar response-script
945 responses line-by-line from the specified
947 file instead of prompting interactively.
951 will refuse to run if certain preconditions are not met.
952 If a file contains merge conflicts, these conflicts must be resolved first.
953 If a file is found to be out of date relative to the head commit on the
954 work tree's current branch, the file must be updated with
956 before it can be staged (however, this does not prevent the file from
957 becoming out-of-date at some point after having been staged).
964 commands will refuse to run while staged changes exist.
965 If staged changes cannot be committed because a staged path
966 is out of date, the path must be unstaged with
968 before it can be updated with
970 and may then be staged again if necessary.
974 .It Cm unstage [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
975 Merge staged changes back into the work tree and put affected paths
976 back into non-staged status.
979 is specified, unstage all staged changes across the entire work tree.
980 Otherwise, unstage changes at or within the specified paths.
982 Show the status of each affected file, using the following status codes:
983 .Bl -column YXZ description
984 .It G Ta file was unstaged
985 .It C Ta file was unstaged and conflicts occurred during merge
986 .It ! Ta changes destined for a missing file were not merged
987 .It D Ta file was staged as deleted and still is deleted
988 .It d Ta file's deletion was obstructed by local modifications
989 .It ~ Ta changes destined for a non-regular file were not merged
997 Instead of unstaging the entire content of a changed file, interactively
998 select or reject changes for unstaging based on
1002 (keep change staged), and
1004 (quit unstaging this file) responses.
1005 If a file is staged in modified status, individual patches derived from the
1006 staged file content can be unstaged.
1007 Files staged in added or deleted status may only be unstaged in their entirety.
1008 .It Fl F Ar response-script
1016 responses line-by-line from the specified
1018 file instead of prompting interactively.
1025 .Bl -tag -width GOT_AUTHOR
1027 The author's name and email address for
1032 .An Flan Hacker Aq Mt flan_hacker@openbsd.org
1033 .It Ev VISUAL, Ev EDITOR
1034 The editor spawned by
1040 Clone an existing Git repository for use with
1042 This step currently requires
1046 .Dl $ git clone --bare https://github.com/openbsd/src.git
1048 Alternatively, for quick and dirty local testing of
1050 a new Git repository could be created and populated with files,
1051 e.g. from a temporary CVS checkout located at
1054 .Dl $ got init /var/git/src.git
1055 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1057 Check out a work tree from the Git repository to /usr/src:
1059 .Dl $ got checkout /var/git/src.git /usr/src
1061 View local changes in a work tree directory:
1064 .Dl $ got diff | less
1066 In a work tree or a git repository directory, list all branch references:
1070 In a work tree or a git repository directory, create a new branch called
1071 .Dq unified-buffer-cache
1072 which is forked off the
1076 .Dl $ got branch unified-buffer-cache master
1078 Switch an existing work tree to the branch
1079 .Dq unified-buffer-cache .
1080 Local changes in the work tree will be preserved and merged if necessary:
1082 .Dl $ got update -b unified-buffer-cache
1084 Create a new commit from local changes in a work tree directory.
1085 This new commit will become the head commit of the work tree's current branch:
1089 In a work tree or a git repository directory, view changes committed in
1090 the 3 most recent commits to the work tree's branch, or the branch resolved
1091 via the repository's HEAD reference, respectively:
1093 .Dl $ got log -p -l 3 -f
1095 Add new files and remove obsolete files in a work tree directory:
1097 .Dl $ got add sys/uvm/uvm_ubc.c
1098 .Dl $ got remove sys/uvm/uvm_vnode.c
1100 Create a new commit from local changes in a work tree directory
1101 with a pre-defined log message.
1103 .Dl $ got commit -m 'unify the buffer cache'
1105 Update any work tree checked out from the
1106 .Dq unified-buffer-cache
1107 branch to the latest commit on this branch:
1111 Roll file content on the unified-buffer-cache branch back by one commit,
1112 and then fetch the rolled-back change into the work tree as a local change
1113 to be amended and perhaps committed again:
1115 .Dl $ got backout unified-buffer-cache
1116 .Dl $ got commit -m 'roll back previous'
1117 .Dl $ # now back out the previous backout :-)
1118 .Dl $ got backout unified-buffer-cache
1120 Fetch new upstream commits into the local repository's master branch.
1121 This step currently requires
1124 .Dl $ cd /var/git/src.git
1125 .Dl $ git fetch origin master:master
1128 .Dq unified-buffer-cache
1129 branch on top of the new head commit of the
1133 .Dl $ got update -b master
1134 .Dl $ got rebase unified-buffer-cache
1136 Create a patch from all changes on the unified-buffer-cache branch.
1137 The patch can be mailed out for review and applied to OpenBSD's CVS tree:
1139 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1141 Edit the entire commit history of the
1142 .Dq unified-buffer-cache
1145 .Dl $ got update -b unified-buffer-cache
1146 .Dl $ got update -c master
1149 Additional steps are necessary if local changes need to be pushed back
1150 to the remote repository, which currently requires
1154 Before working against existing branches in a repository cloned with
1155 .Dq git clone --bare ,
1158 must be configured to map all references in the remote repository
1161 namespace of the local repository.
1162 This can achieved by setting Git's
1163 .Pa remote.origin.fetch
1164 configuration variable to the value
1165 .Dq +refs/heads/*:refs/remotes/origin/*
1170 .Dl $ cd /var/git/repo
1171 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1173 Alternatively, the following
1175 configuration item can be added manually to the Git repository's
1179 .Dl [remote "origin"]
1181 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1183 This configuration leaves the local repository's
1185 namespace free for use by local branches checked out with
1187 and, if needed, created with
1192 namespace can be updated with incoming changes from the remote
1196 .Dl $ cd /var/git/repo
1199 Before outgoing changes on the local
1201 branch can be pushed to the remote repository, the local
1203 branch must be rebased onto the
1207 .Dl $ got update -b origin/master
1208 .Dl $ got rebase master
1210 Changes on the local
1212 branch can then be pushed to the remote
1216 .Dl $ cd /var/git/repo
1217 .Dl $ git push origin master
1221 .Xr git-repository 5 ,
1224 .An Stefan Sperling Aq Mt stsp@openbsd.org
1225 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1226 .An joshua stein Aq Mt jcs@openbsd.org
1229 is a work-in-progress and many commands remain to be implemented.
1230 At present, the user has to fall back on
1232 to perform many tasks, in particular tasks related to repository
1233 administration and tasks which require a network connection.
