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.
62 .Bl -tag -width checkout
63 .It Cm init Ar repository-path
64 Create a new empty repository at the specified
71 command must be used to populate the empty repository before
75 .It Cm import [ Fl b Ar branch ] [ Fl m Ar message ] [ Fl r Ar repository-path ] [ Fl I Ar pattern ] directory
76 Create an initial commit in a repository from the file hierarchy
79 The created commit will not have any parent commits, i.e. it will be a
81 Also create a new reference which provides a branch name for the newly
83 Show the path of each imported file to indicate progress.
89 environment variable to be set.
98 instead of creating the default branch
100 Use of this option is required if the
102 branch already exists.
104 Use the specified log message when creating the new commit.
109 opens a temporary file in an editor where a log message can be written.
110 .It Fl r Ar repository-path
111 Use the repository at the specified path.
112 If not specified, assume the repository is located at or above the current
115 Ignore files or directories with a name which matches the specified
117 This option may be specified multiple times to build a list of ignore patterns.
120 follows the globbing rules documented in
123 .It Cm checkout [ Fl b Ar branch ] [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
124 Copy files from a repository into a new work tree.
127 is not specified, either use the last component of
128 .Ar repository path ,
131 was specified use the last component of
139 Check out files from the specified
141 If this option is not specified, a branch resolved via the repository's HEAD
142 reference will be used.
144 Check out files from the specified
146 The expected argument is a commit ID SHA1 hash or an existing reference
147 which will be resolved to a commit ID.
148 An abbreviated hash argument will be expanded to a full SHA1 hash
149 automatically, provided the abbreviation is unique.
150 If this option is not specified, the most recent commit on the selected
152 .It Fl p Ar path-prefix
153 Restrict the work tree to a subset of the repository's tree hierarchy.
154 Only files beneath the specified
161 .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ... ]
162 Update an existing work tree to a different commit.
163 Show the status of each affected file, using the following status codes:
164 .Bl -column YXZ description
165 .It U Ta file was updated and contained no local changes
166 .It G Ta file was updated and local changes were merged cleanly
167 .It C Ta file was updated and conflicts occurred during merge
168 .It D Ta file was deleted
169 .It A Ta new file was added
170 .It ~ Ta versioned file is obstructed by a non-regular file
171 .It ! Ta a missing versioned file was restored
176 is specified, update the entire work tree.
177 Otherwise, restrict the update operation to files at or within the
179 Each path is required to exist in the update operation's target commit.
180 Files in the work tree outside specified paths will remain unchanged and
181 will retain their previously recorded base commit.
184 commands may refuse to run while the work tree contains files from
185 multiple base commits.
186 The base commit of such a work tree can be made consistent by running
188 across the entire work tree.
191 is incompatible with the
200 Switch the work tree's branch reference to the specified
202 before updating the work tree.
203 This option requires that all paths in the work tree are updated.
205 Update the work tree to the specified
207 The expected argument is a commit ID SHA1 hash or an existing reference
208 which will be resolved to a commit ID.
209 An abbreviated hash argument will be expanded to a full SHA1 hash
210 automatically, provided the abbreviation is unique.
211 If this option is not specified, the most recent commit on the work tree's
217 .It Cm status [ Ar path ... ]
218 Show the current modification status of files in a work tree,
219 using the following status codes:
220 .Bl -column YXZ description
221 .It M Ta modified file
222 .It A Ta file scheduled for addition in next commit
223 .It D Ta file scheduled for deletion in next commit
224 .It C Ta modified or added file which contains merge conflicts
225 .It ! Ta versioned file was expected on disk but is missing
226 .It ~ Ta versioned file is obstructed by a non-regular file
227 .It ? Ta unversioned item not tracked by
233 is specified, show modifications in the entire work tree.
234 Otherwise, show modifications at or within the specified paths.
238 .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 ]
239 Display history of a repository.
242 is specified, show only commits which modified this path.
249 Start traversing history at the specified
251 The expected argument is a commit ID SHA1 hash or an existing reference
252 which will be resolved to a commit ID.
253 An abbreviated hash argument will be expanded to a full SHA1 hash
254 automatically, provided the abbreviation is unique.
255 If this option is not specified, default to the work tree's current branch
256 if invoked in a work tree, or to the repository's HEAD reference.
258 Set the number of context lines shown in diffs with
260 By default, 3 lines of context are shown.
262 Restrict history traversal to the first parent of each commit.
263 This shows the linear history of the current branch only.
264 Merge commits which affected the current branch will be shown but
265 individual commits which originated on other branches will be omitted.
267 Limit history traversal to a given number of commits.
269 Display the patch of modifications made in each commit.
270 .It Fl r Ar repository-path
271 Use the repository at the specified path.
272 If not specified, assume the repository is located at or above the current
274 If this directory is a
276 work tree, use the repository path associated with this work tree.
278 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
279 When invoked within a work tree with less than two arguments, display
280 uncommitted changes in the work tree.
283 is specified, only show changes within this path.
285 If two arguments are provided, treat each argument as a reference,
286 or an object ID SHA1 hash, and display differences between these objects.
287 Both objects must be of the same type (blobs, trees, or commits).
288 An abbreviated hash argument will be expanded to a full SHA1 hash
289 automatically, provided the abbreviation is unique.
296 Set the number of context lines shown in the diff.
297 By default, 3 lines of context are shown.
298 .It Fl r Ar repository-path
299 Use the repository at the specified path.
300 If not specified, assume the repository is located at or above the current
302 If this directory is a
304 work tree, use the repository path associated with this work tree.
306 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
307 Display line-by-line history of a file at the specified path.
314 Start traversing history at the specified
316 The expected argument is a commit ID SHA1 hash or an existing reference
317 which will be resolved to a commit ID.
318 An abbreviated hash argument will be expanded to a full SHA1 hash
319 automatically, provided the abbreviation is unique.
320 .It Fl r Ar repository-path
321 Use the repository at the specified path.
322 If not specified, assume the repository is located at or above the current
324 If this directory is a
326 work tree, use the repository path associated with this work tree.
328 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
329 Display a listing of files and directories at the specified
330 directory path in the repository.
331 Entries shown in this listing may carry one of the following trailing
333 .Bl -column YXZ description
334 .It / Ta entry is a directory
335 .It * Ta entry is an executable file
340 is specified, list the repository path corresponding to the current
341 directory of the work tree, or the root directory of the repository
342 if there is no work tree.
349 List files and directories as they appear in the specified
351 The expected argument is a commit ID SHA1 hash or an existing reference
352 which will be resolved to a commit ID.
353 An abbreviated hash argument will be expanded to a full SHA1 hash
354 automatically, provided the abbreviation is unique.
355 .It Fl r Ar repository-path
356 Use the repository at the specified path.
357 If not specified, assume the repository is located at or above the current
359 If this directory is a
361 work tree, use the repository path associated with this work tree.
363 Show object IDs of files (blob objects) and directories (tree objects).
365 Recurse into sub-directories in the repository.
367 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
368 Manage references in a repository.
370 If no options are passed, expect two arguments and attempt to create,
371 or update, the reference with the given
373 and make it point at the given
375 The target may be an object ID SHA1 hash or an existing reference which
376 will be resolved to an object ID.
377 An abbreviated hash argument will be expanded to a full SHA1 hash
378 automatically, provided the abbreviation is unique.
384 .It Fl r Ar repository-path
385 Use the repository at the specified path.
386 If not specified, assume the repository is located at or above the current
388 If this directory is a
390 work tree, use the repository path associated with this work tree.
392 List all existing references in the repository.
394 Delete the reference with the specified name from the repository.
396 .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
397 Manage branches in a repository.
399 Branches are managed via references which live in the
404 command operates on references in this namespace only.
406 If no options are passed, expect one or two arguments and attempt to create
407 a branch with the given
409 and make it point at the given
413 is specified, default to the work tree's current branch if invoked in a
414 work tree, or to the repository's HEAD reference.
420 .It Fl r Ar repository-path
421 Use the repository at the specified path.
422 If not specified, assume the repository is located at or above the current
424 If this directory is a
426 work tree, use the repository path associated with this work tree.
428 List all existing branches in the repository.
429 If invoked in a work tree, the work tree's current branch is shown
430 with one the following annotations:
431 .Bl -column YXZ description
432 .It * Ta work tree's base commit matches the branch tip
433 .It ~ Ta work tree's base commit is out-of-date
436 Delete the branch with the specified name from the repository.
437 Only the branch reference is deleted.
438 Any commit, tree, and blob objects belonging to the branch
439 remain in the repository and may be removed separately with
440 Git's garbage collector.
445 .It Cm add Ar file-path ...
446 Schedule unversioned files in a work tree for addition to the
447 repository in the next commit.
448 .It Cm remove Ar file-path ...
449 Remove versioned files from a work tree and schedule them for deletion
450 from the repository in the next commit.
457 Perform the operation even if a file contains uncommitted modifications.
462 .It Cm revert Ar file-path ...
463 Revert any uncommited changes in files at the specified paths.
464 File contents will be overwritten with those contained in the
465 work tree's base commit. There is no way to bring discarded
469 If a file was added with
471 it will become an unversioned file again.
472 If a file was deleted with
478 .It Cm commit [ Fl m Ar message ] [ path ]
479 Create a new commit in the repository from local changes in a work tree
480 and use this commit as the new base commit for the work tree.
483 is specified, only commit local changes at or within this path.
485 Show the status of each affected file, using the following status codes:
486 .Bl -column YXZ description
487 .It M Ta modified file
488 .It D Ta file was deleted
489 .It A Ta new file was added
492 Files without local changes will retain their previously recorded base
496 commands may refuse to run while the work tree contains files from
497 multiple base commits.
498 The base commit of such a work tree can be made consistent by running
500 across the entire work tree.
506 environment variable to be set.
513 Use the specified log message when creating the new commit.
518 opens a temporary file in an editor where a log message can be written.
523 .It Cm cherrypick Ar commit
524 Merge changes from a single
529 must be on a different branch than the work tree's base commit.
530 The expected argument is a reference or a commit ID SHA1 hash.
531 An abbreviated hash argument will be expanded to a full SHA1 hash
532 automatically, provided the abbreviation is unique.
534 Show the status of each affected file, using the following status codes:
535 .Bl -column YXZ description
536 .It G Ta file was merged
537 .It C Ta file was merged and conflicts occurred during merge
538 .It ! Ta changes destined for a missing file were not merged
539 .It D Ta file was deleted
540 .It d Ta file's deletion was obstructed by local modifications
541 .It A Ta new file was added
542 .It ~ Ta changes destined for a non-regular file were not merged
545 The merged changes will appear as local changes in the work tree, which
548 amended manually or with further
553 or discarded again with
557 will refuse to run if certain preconditions are not met.
558 If the work tree contains multiple base commits it must first be updated
559 to a single base commit with
561 If the work tree already contains files with merge conflicts, these
562 conflicts must be resolved first.
566 .It Cm backout Ar commit
567 Reverse-merge changes from a single
572 must be on the same branch as the work tree's base commit.
573 The expected argument is a reference or a commit ID SHA1 hash.
574 An abbreviated hash argument will be expanded to a full SHA1 hash
575 automatically, provided the abbreviation is unique.
577 Show the status of each affected file, using the following status codes:
578 .Bl -column YXZ description
579 .It G Ta file was merged
580 .It C Ta file was merged and conflicts occurred during merge
581 .It ! Ta changes destined for a missing file were not merged
582 .It D Ta file was deleted
583 .It d Ta file's deletion was obstructed by local modifications
584 .It A Ta new file was added
585 .It ~ Ta changes destined for a non-regular file were not merged
588 The reverse-merged changes will appear as local changes in the work tree,
589 which may be viewed with
591 amended manually or with further
596 or discarded again with
600 will refuse to run if certain preconditions are not met.
601 If the work tree contains multiple base commits it must first be updated
602 to a single base commit with
604 If the work tree already contains files with merge conflicts, these
605 conflicts must be resolved first.
609 .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
610 Rebase commits on the specified
612 onto the tip of the current branch of the work tree.
615 must share common ancestry with the work tree's current branch.
616 Rebasing begins with the first descendent commit of the youngest
617 common ancestor commit shared by the specified
619 and the work tree's current branch, and stops once the tip commit
624 Rebased commits are accumulated on a temporary branch and represent
625 the same changes with the same log messages as their counterparts
628 but with different commit IDs.
629 Once rebasing has completed successfully, the temporary branch becomes
630 the new version of the specified
632 and the work tree is automatically switched to it.
634 While rebasing commits, show the status of each affected file,
635 using the following status codes:
636 .Bl -column YXZ description
637 .It G Ta file was merged
638 .It C Ta file was merged and conflicts occurred during merge
639 .It ! Ta changes destined for a missing file were not merged
640 .It D Ta file was deleted
641 .It d Ta file's deletion was obstructed by local modifications
642 .It A Ta new file was added
643 .It ~ Ta changes destined for a non-regular file were not merged
646 If merge conflicts occur the rebase operation is interrupted and may
647 be continued once conflicts have been resolved.
648 Alternatively, the rebase operation may be aborted which will leave
650 unmodified and the work tree switched back to its original branch.
652 If a merge conflict is resolved in a way which renders the merged
653 change into a no-op change, the corresponding commit will be elided
654 when the rebase operation continues.
657 will refuse to run if certain preconditions are not met.
658 If the work tree contains multiple base commits it must first be updated
659 to a single base commit with
661 If the work tree contains local changes, these changes must first be
668 contains changes to files outside of the work tree's path prefix,
669 the work tree cannot be used to rebase this branch.
675 commands will refuse to run while a rebase operation is in progress.
676 Other commands which manipulate the work tree may be used for
677 conflict resolution purposes.
684 Abort an interrupted rebase operation.
685 If this option is used, no further command-line arguments are allowed.
687 Continue an interrupted rebase operation.
688 If this option is used, no further command-line arguments are allowed.
693 .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
694 Edit commit history between the work tree's current base commit and
695 the tip commit of the work tree's current branch.
697 Editing of commit history is controlled via a
699 which can be edited interactively or passed on the command line.
700 The format of the histedit script is line-based.
701 Each line in the script begins with a command name, followed by
702 whitespace and an argument.
703 For most commands, the expected argument is a commit ID SHA1 hash.
704 Any remaining text on the line is ignored.
705 Lines which begin with the
707 character are ignored entirely.
709 The available commands are as follows:
710 .Bl -column YXZ pick-commit
711 .It pick Ar commit Ta Use the specified commit as it is.
712 .It edit Ar commit Ta Use the specified commit but once changes have been
713 merged into the work tree interrupt the histedit operation for amending.
714 .It fold Ar commit Ta Combine the specified commit with the next commit
715 listed further below that will be used.
716 .It drop Ar commit Ta Remove this commit from the edited history.
717 .It mesg Ar log-message Ta Use the specified single-line log message for
718 the commit on the previous line.
719 If the log message argument is left empty, open an editor where a new
720 log message can be written.
723 Every commit in the history being edited must be mentioned in the script.
724 Lines may be re-ordered to change the order of commits in the edited history.
726 Edited commits are accumulated on a temporary branch.
727 Once history editing has completed successfully, the temporary branch becomes
728 the new version of the work tree's branch and the work tree is automatically
731 While merging commits, show the status of each affected file,
732 using the following status codes:
733 .Bl -column YXZ description
734 .It G Ta file was merged
735 .It C Ta file was merged and conflicts occurred during merge
736 .It ! Ta changes destined for a missing file were not merged
737 .It D Ta file was deleted
738 .It d Ta file's deletion was obstructed by local modifications
739 .It A Ta new file was added
740 .It ~ Ta changes destined for a non-regular file were not merged
743 If merge conflicts occur the histedit operation is interrupted and may
744 be continued once conflicts have been resolved.
745 Alternatively, the histedit operation may be aborted which will leave
746 the work tree switched back to its original branch.
748 If a merge conflict is resolved in a way which renders the merged
749 change into a no-op change, the corresponding commit will be elided
750 when the histedit operation continues.
753 will refuse to run if certain preconditions are not met.
754 If the work tree contains multiple base commits it must first be updated
755 to a single base commit with
757 If the work tree contains local changes, these changes must first be
762 If the edited history contains changes to files outside of the work tree's
763 path prefix, the work tree cannot be used to edit the history of this branch.
767 command will refuse to run while a histedit operation is in progress.
768 Other commands which manipulate the work tree may be used, and the
770 command may be used to commit arbitrary changes to the temporary branch
771 while the histedit operation is interrupted.
778 Abort an interrupted histedit operation.
779 If this option is used, no further command-line arguments are allowed.
781 Continue an interrupted histedit operation.
782 If this option is used, no further command-line arguments are allowed.
789 .Bl -tag -width GOT_AUTHOR
791 The author's name and email address for
796 .An Stefan Sperling Aq Mt stsp@openbsd.org
797 .It Ev VISUAL, Ev EDITOR
798 The editor spawned by
804 Clone an existing Git repository for use with
806 This step currently requires
810 .Dl $ git clone --bare https://github.com/openbsd/src.git
812 Alternatively, for quick and dirty local testing of
814 a new Git repository could be created and populated with files,
815 e.g. from a temporary CVS checkout located at
818 .Dl $ got init /var/git/src.git
819 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
821 Check out a work tree from the Git repository to /usr/src:
823 .Dl $ got checkout /var/git/src.git /usr/src
825 View local changes in a work tree directory:
828 .Dl $ got diff | less
830 In a work tree or a git repository directory, list all branch references:
834 In a work tree or a git repository directory, create a new branch called
835 .Dq unified-buffer-cache
836 which is forked off the
840 .Dl $ got branch unified-buffer-cache master
842 Switch an existing work tree to the branch
843 .Dq unified-buffer-cache .
844 Local changes in the work tree will be preserved and merged if necessary:
846 .Dl $ got update -b unified-buffer-cache
848 Create a new commit from local changes in a work tree directory.
849 This new commit will become the head commit of the work tree's current branch:
853 In a work tree or a git repository directory, view changes committed in
854 the 3 most recent commits to the work tree's branch, or the branch resolved
855 via the repository's HEAD reference, respectively:
857 .Dl $ got log -p -l 3 -f
859 Add new files and remove obsolete files in a work tree directory:
861 .Dl $ got add sys/uvm/uvm_ubc.c
862 .Dl $ got remove sys/uvm/uvm_vnode.c
864 Create a new commit from local changes in a work tree directory
865 with a pre-defined log message.
867 .Dl $ got commit -m 'unify the buffer cache'
869 Update any work tree checked out from the
870 .Dq unified-buffer-cache
871 branch to the latest commit on this branch:
875 Roll file content on the unified-buffer-cache branch back by one commit,
876 and then fetch the rolled-back change into the work tree as a local change
877 to be amended and perhaps committed again:
879 .Dl $ got backout unified-buffer-cache
880 .Dl $ got commit -m 'roll back previous'
881 .Dl $ # now back out the previous backout :-)
882 .Dl $ got backout unified-buffer-cache
884 Fetch new upstream commits into the local repository's master branch.
885 This step currently requires
888 .Dl $ cd /var/git/src.git
889 .Dl $ git fetch origin master:master
892 .Dq unified-buffer-cache
893 branch on top of the new head commit of the
897 .Dl $ got update -b master
898 .Dl $ got rebase unified-buffer-cache
900 Create a patch from all changes on the unified-buffer-cache branch.
901 The patch can be mailed out for review and applied to OpenBSD's CVS tree:
903 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
905 Edit the entire commit history of the
906 .Dq unified-buffer-cache
909 .Dl $ got update -b unified-buffer-cache
910 .Dl $ got update -c master
915 .Xr git-repository 5 ,
918 .An Stefan Sperling Aq Mt stsp@openbsd.org
919 .An Martin Pieuchot Aq Mt mpi@openbsd.org
920 .An joshua stein Aq Mt jcs@openbsd.org
923 is a work-in-progress and many commands remain to be implemented.
924 At present, the user has to fall back on
926 to perform tasks related to repository administration and tasks
927 which require a network connection.
929 When working against a repository created with
930 .Dq git clone --bare ,
933 branch are discouraged, for now, if changes committed to the upstream
934 repository need to be tracked.
935 See the EXAMPLES section.
940 commands should alleviate this problem.
