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
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.
147 An abbreviated hash argument will be expanded to a full SHA1 hash
148 automatically, provided the abbreviation is unique.
149 If this option is not specified, the most recent commit on the selected
151 .It Fl p Ar path-prefix
152 Restrict the work tree to a subset of the repository's tree hierarchy.
153 Only files beneath the specified
160 .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ]
161 Update an existing work tree to a different commit.
162 Show the status of each affected file, using the following status codes:
163 .Bl -column YXZ description
164 .It U Ta file was updated and contained no local changes
165 .It G Ta file was updated and local changes were merged cleanly
166 .It C Ta file was updated and conflicts occurred during merge
167 .It D Ta file was deleted
168 .It A Ta new file was added
169 .It ~ Ta versioned file is obstructed by a non-regular file
170 .It ! Ta a missing versioned file was restored
175 is specified, restrict the update operation to files at or within this path.
176 The path is required to exist in the update operation's target commit.
177 Files in the work tree outside this path will remain unchanged and will
178 retain their previously recorded base commit.
181 commands may refuse to run while the work tree contains files from
182 multiple base commits.
183 The base commit of such a work tree can be made consistent by running
185 across the entire work tree.
188 is incompatible with the
197 Switch the work tree's branch reference to the specified
199 before updating the work tree.
200 This option requires that all paths in the work tree are updated.
202 Update the work tree to the specified
204 The expected argument is a commit ID SHA1 hash.
205 An abbreviated hash argument will be expanded to a full SHA1 hash
206 automatically, provided the abbreviation is unique.
207 If this option is not specified, the most recent commit on the work tree's
213 .It Cm status [ Ar path ]
214 Show the current modification status of files in a work tree,
215 using the following status codes:
216 .Bl -column YXZ description
217 .It M Ta modified file
218 .It A Ta file scheduled for addition in next commit
219 .It D Ta file scheduled for deletion in next commit
220 .It C Ta modified or added file which contains merge conflicts
221 .It ! Ta versioned file was expected on disk but is missing
222 .It ~ Ta versioned file is obstructed by a non-regular file
223 .It ? Ta unversioned item not tracked by
229 is specified, only show modifications within this path.
233 .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 ]
234 Display history of a repository.
237 is specified, show only commits which modified this path.
244 Start traversing history at the specified
246 The expected argument is the name of a branch or a commit ID SHA1 hash.
247 An abbreviated hash argument will be expanded to a full SHA1 hash
248 automatically, provided the abbreviation is unique.
249 If this option is not specified, default to the work tree's current branch
250 if invoked in a work tree, or to the repository's HEAD reference.
252 Set the number of context lines shown in diffs with
254 By default, 3 lines of context are shown.
256 Restrict history traversal to the first parent of each commit.
257 This shows the linear history of the current branch only.
258 Merge commits which affected the current branch will be shown but
259 individual commits which originated on other branches will be omitted.
261 Limit history traversal to a given number of commits.
263 Display the patch of modifications made in each commit.
264 .It Fl r Ar repository-path
265 Use the repository at the specified path.
266 If not specified, assume the repository is located at or above the current
268 If this directory is a
270 work tree, use the repository path associated with this work tree.
272 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
273 When invoked within a work tree with less than two arguments, display
274 uncommitted changes in the work tree.
277 is specified, only show changes within this path.
279 If two arguments are provided, treat each argument as a reference,
280 or an object ID SHA1 hash, and display differences between these objects.
281 Both objects must be of the same type (blobs, trees, or commits).
282 An abbreviated hash argument will be expanded to a full SHA1 hash
283 automatically, provided the abbreviation is unique.
290 Set the number of context lines shown in the diff.
291 By default, 3 lines of context are shown.
292 .It Fl r Ar repository-path
293 Use the repository at the specified path.
294 If not specified, assume the repository is located at or above the current
296 If this directory is a
298 work tree, use the repository path associated with this work tree.
300 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
301 Display line-by-line history of a file at the specified path.
308 Start traversing history at the specified
310 The expected argument is the name of a branch or a commit ID SHA1 hash.
311 An abbreviated hash argument will be expanded to a full SHA1 hash
312 automatically, provided the abbreviation is unique.
313 .It Fl r Ar repository-path
314 Use the repository at the specified path.
315 If not specified, assume the repository is located at or above the current
317 If this directory is a
319 work tree, use the repository path associated with this work tree.
321 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
322 Display a listing of files and directories at the specified
323 directory path in the repository.
324 Entries shown in this listing may carry one of the following trailing
326 .Bl -column YXZ description
327 .It / Ta entry is a directory
328 .It * Ta entry is an executable file
333 is specified, list the repository path corresponding to the current
334 directory of the work tree, or the root directory of the repository
335 if there is no work tree.
342 List files and directories as they appear in the specified
344 The expected argument is the name of a branch or a commit ID SHA1 hash.
345 An abbreviated hash argument will be expanded to a full SHA1 hash
346 automatically, provided the abbreviation is unique.
347 .It Fl r Ar repository-path
348 Use the repository at the specified path.
349 If not specified, assume the repository is located at or above the current
351 If this directory is a
353 work tree, use the repository path associated with this work tree.
355 Show object IDs of files (blob objects) and directories (tree objects).
357 Recurse into sub-directories in the repository.
359 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
360 Manage references in a repository.
362 If no options are passed, expect two arguments and attempt to create,
363 or update, the reference with the given
365 and make it point at the given
367 The target may be an object ID SHA1 hash or an existing reference which
368 will be resolved to an object ID.
369 An abbreviated hash argument will be expanded to a full SHA1 hash
370 automatically, provided the abbreviation is unique.
376 .It Fl r Ar repository-path
377 Use the repository at the specified path.
378 If not specified, assume the repository is located at or above the current
380 If this directory is a
382 work tree, use the repository path associated with this work tree.
384 List all existing references in the repository.
386 Delete the reference with the specified name from the repository.
388 .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
389 Manage branches in a repository.
391 Branches are managed via references which live in the
396 command operates on references in this namespace only.
398 If no options are passed, expect one or two arguments and attempt to create
399 a branch with the given
401 and make it point at the given
405 is specified, default to the work tree's current branch if invoked in a
406 work tree, or to the repository's HEAD reference.
412 .It Fl r Ar repository-path
413 Use the repository at the specified path.
414 If not specified, assume the repository is located at or above the current
416 If this directory is a
418 work tree, use the repository path associated with this work tree.
420 List all existing branches in the repository.
422 If invoked in a work tree, the work tree's current branch is shown
423 with one the following annotations:
424 .Bl -column YXZ description
425 .It * Ta work tree's base commit matches the branch tip
426 .It ~ Ta work tree's base commit is out-of-date
429 Delete the branch with the specified name from the repository.
430 Only the branch reference is deleted.
431 Any commit, tree, and blob objects belonging to the branch
432 remain in the repository and may be removed separately with
433 Git's garbage collector.
438 .It Cm add Ar file-path ...
439 Schedule unversioned files in a work tree for addition to the
440 repository in the next commit.
441 .It Cm remove Ar file-path ...
442 Remove versioned files from a work tree and schedule them for deletion
443 from the repository in the next commit.
450 Perform the operation even if a file contains uncommitted modifications.
455 .It Cm revert Ar file-path ...
456 Revert any uncommited changes in files at the specified paths.
457 File contents will be overwritten with those contained in the
458 work tree's base commit. There is no way to bring discarded
462 If a file was added with
464 it will become an unversioned file again.
465 If a file was deleted with
471 .It Cm commit [ Fl m Ar message ] [ file-path ]
472 Create a new commit in the repository from local changes in a work tree
473 and use this commit as the new base commit for the work tree.
475 Show the status of each affected file, using the following status codes:
476 .Bl -column YXZ description
477 .It M Ta modified file
478 .It D Ta file was deleted
479 .It A Ta new file was added
482 Files without local changes will retain their previously recorded base
486 commands may refuse to run while the work tree contains files from
487 multiple base commits.
488 The base commit of such a work tree can be made consistent by running
490 across the entire work tree.
496 environment variable to be set.
503 Use the specified log message when creating the new commit.
508 opens a temporary file in an editor where a log message can be written.
513 .It Cm cherrypick Ar commit
514 Merge changes from a single
519 must be on a different branch than the work tree's base commit.
520 The expected argument is a reference or a commit ID SHA1 hash.
521 An abbreviated hash argument will be expanded to a full SHA1 hash
522 automatically, provided the abbreviation is unique.
524 Show the status of each affected file, using the following status codes:
525 .Bl -column YXZ description
526 .It G Ta file was merged
527 .It C Ta file was merged and conflicts occurred during merge
528 .It ! Ta changes destined for a missing file were not merged
529 .It D Ta file was deleted
530 .It d Ta file's deletion was obstructed by local modifications
531 .It A Ta new file was added
532 .It ~ Ta changes destined for a non-regular file were not merged
535 The merged changes will appear as local changes in the work tree, which
538 amended manually or with further
543 or discarded again with
547 will refuse to run if certain preconditions are not met.
548 If the work tree contains multiple base commits it must first be updated
549 to a single base commit with
551 If the work tree already contains files with merge conflicts, these
552 conflicts must be resolved first.
556 .It Cm backout Ar commit
557 Reverse-merge changes from a single
562 must be on the same branch as the work tree's base commit.
563 The expected argument is a reference or a commit ID SHA1 hash.
564 An abbreviated hash argument will be expanded to a full SHA1 hash
565 automatically, provided the abbreviation is unique.
567 Show the status of each affected file, using the following status codes:
568 .Bl -column YXZ description
569 .It G Ta file was merged
570 .It C Ta file was merged and conflicts occurred during merge
571 .It ! Ta changes destined for a missing file were not merged
572 .It D Ta file was deleted
573 .It d Ta file's deletion was obstructed by local modifications
574 .It A Ta new file was added
575 .It ~ Ta changes destined for a non-regular file were not merged
578 The reverse-merged changes will appear as local changes in the work tree,
579 which may be viewed with
581 amended manually or with further
586 or discarded again with
590 will refuse to run if certain preconditions are not met.
591 If the work tree contains multiple base commits it must first be updated
592 to a single base commit with
594 If the work tree already contains files with merge conflicts, these
595 conflicts must be resolved first.
599 .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
600 Rebase commits on the specified
602 onto the tip of the current branch of the work tree.
605 must share common ancestry with the work tree's current branch.
606 Rebasing begins with the first descendent commit of the youngest
607 common ancestor commit shared by the specified
609 and the work tree's current branch, and stops once the tip commit
614 Rebased commits are accumulated on a temporary branch and represent
615 the same changes with the same log messages as their counterparts
618 but with different commit IDs.
619 Once rebasing has completed successfully, the temporary branch becomes
620 the new version of the specified
622 and the work tree is automatically switched to it.
624 While rebasing commits, show the status of each affected file,
625 using the following status codes:
626 .Bl -column YXZ description
627 .It G Ta file was merged
628 .It C Ta file was merged and conflicts occurred during merge
629 .It ! Ta changes destined for a missing file were not merged
630 .It D Ta file was deleted
631 .It d Ta file's deletion was obstructed by local modifications
632 .It A Ta new file was added
633 .It ~ Ta changes destined for a non-regular file were not merged
636 If merge conflicts occur the rebase operation is interrupted and may
637 be continued once conflicts have been resolved.
638 Alternatively, the rebase operation may be aborted which will leave
640 unmodified and the work tree switched back to its original branch.
642 If a merge conflict is resolved in a way which renders the merged
643 change into a no-op change, the corresponding commit will be elided
644 when the rebase operation continues.
647 will refuse to run if certain preconditions are not met.
648 If the work tree contains multiple base commits it must first be updated
649 to a single base commit with
651 If the work tree contains local changes, these changes must first be
658 contains changes to files outside of the work tree's path prefix,
659 the work tree cannot be used to rebase this branch.
665 commands will refuse to run while a rebase operation is in progress.
666 Other commands which manipulate the work tree may be used for
667 conflict resolution purposes.
674 Abort an interrupted rebase operation.
675 If this option is used, no further command-line arguments are allowed.
677 Continue an interrupted rebase operation.
678 If this option is used, no further command-line arguments are allowed.
685 .Bl -tag -width GOT_AUTHOR
687 The author's name and email address for
692 .An Stefan Sperling Aq Mt stsp@openbsd.org
693 .It Ev VISUAL, Ev EDITOR
694 The editor spawned by
700 Clone an existing Git repository for use with
702 This step currently requires
706 .Dl $ git clone --bare https://github.com/openbsd/src.git
708 Alternatively, for quick and dirty local testing of
710 a new Git repository could be created and populated with files,
711 e.g. from a temporary CVS checkout located at
714 .Dl $ got init /var/git/src.git
715 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
717 Check out a work tree from the Git repository to /usr/src:
719 .Dl $ got checkout /var/git/src.git /usr/src
721 View local changes in a work tree directory:
724 .Dl $ got diff | less
726 In a work tree or a git repository directory, list all branch references:
730 In a work tree or a git repository directory, create a new branch called
731 .Dq unified-buffer-cache
732 which is forked off the
736 .Dl $ got branch unified-buffer-cache master
738 Switch an existing work tree to the branch
739 .Dq unified-buffer-cache .
740 Local changes in the work tree will be preserved and merged if necessary:
742 .Dl $ got update -b unified-buffer-cache
744 Create a new commit from local changes in a work tree directory.
745 This new commit will become the head commit of the work tree's current branch:
749 In a work tree or a git repository directory, view changes committed in
750 the 3 most recent commits to the work tree's branch, or the branch resolved
751 via the repository's HEAD reference, respectively:
753 .Dl $ got log -p -l 3 -f
755 Add new files and remove obsolete files in a work tree directory:
757 .Dl $ got add sys/uvm/uvm_ubc.c
758 .Dl $ got remove sys/uvm/uvm_vnode.c
760 Create a new commit from local changes in a work tree directory
761 with a pre-defined log message.
763 .Dl $ got commit -m 'unify the buffer cache'
765 Update any work tree checked out from the
766 .Dq unified-buffer-cache
767 branch to the latest commit on this branch:
771 Fetch new upstream commits into the local repository's master branch.
772 This step currently requires
775 .Dl $ cd /var/git/src.git
776 .Dl $ git fetch origin master:master
779 .Dq unified-buffer-cache
780 branch on top of the new head commit of the
784 .Dl $ got update -b master
785 .Dl $ got rebase unified-buffer-cache
787 Create a patch from all changes on the unified-buffer-cache branch.
788 The patch can be mailed out for review and applied to OpenBSD's CVS tree:
790 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
796 .An Stefan Sperling Aq Mt stsp@openbsd.org
797 .An Martin Pieuchot Aq Mt mpi@openbsd.org
798 .An joshua stein Aq Mt jcs@openbsd.org
801 is a work-in-progress and many commands remain to be implemented.
802 At present, the user has to fall back on
804 to perform tasks related to repository administration and tasks
805 which require a network connection.
807 When working against a repository created with
808 .Dq git clone --bare ,
811 branch are discouraged, for now, if changes committed to the upstream
812 repository need to be tracked.
813 See the EXAMPLES section.
818 commands should alleviate this problem.
