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
66 .It Cm checkout [ Fl b Ar branch ] [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
67 Copy files from a repository into a new work tree.
70 is not specified, either use the last component of
74 was specified use the last component of
82 Check out files from the specified
84 If this option is not specified, a branch resolved via the repository's HEAD
85 reference will be used.
87 Check out files from the specified
89 If this option is not specified, the most recent commit on the selected
91 .It Fl p Ar path-prefix
92 Restrict the work tree to a subset of the repository's tree hierarchy.
93 Only files beneath the specified
97 .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ]
98 Update an existing work tree to a different commit.
99 Show the status of each affected file, using the following status codes:
100 .Bl -column YXZ description
101 .It U Ta file was updated and contained no local changes
102 .It G Ta file was updated and local changes were merged cleanly
103 .It C Ta file was updated and conflicts occurred during merge
104 .It D Ta file was deleted
105 .It A Ta new file was added
106 .It ~ Ta versioned file is obstructed by a non-regular file
107 .It ! Ta a missing versioned file was restored
112 is specified, restrict the update operation to files at or within this path.
113 The path is required to exist in the update operation's target commit.
114 Files in the work tree outside this path will remain unchanged and will
115 retain their previously recorded base commit.
118 commands may refuse to run while the work tree contains files from
119 multiple base commits.
120 The base commit of such a work tree can be made consistent by running
122 across the entire work tree.
125 is incompatible with the
134 Switch the work tree's branch reference to the specified
136 before updating the work tree.
137 This option requires that all paths in the work tree are updated.
139 Update the work tree to the specified
141 The expected argument is a commit ID SHA1 hash.
142 If this option is not specified, the most recent commit on the work tree's
145 .It Cm status [ Ar path ]
146 Show the current modification status of files in a work tree,
147 using the following status codes:
148 .Bl -column YXZ description
149 .It M Ta modified file
150 .It A Ta file scheduled for addition in next commit
151 .It D Ta file scheduled for deletion in next commit
152 .It C Ta modified or added file which contains merge conflicts
153 .It ! Ta versioned file was expected on disk but is missing
154 .It ~ Ta versioned file is obstructed by a non-regular file
155 .It ? Ta unversioned item not tracked by
161 is specified, only show modifications within this path.
162 .It Cm log [ Fl b ] [ Fl c Ar commit ] [ Fl C Ar number ] [ Fl l Ar N ] [ Fl p ] [ Fl r Ar repository-path ] [ path ]
163 Display history of a repository.
166 is specified, show only commits which modified this path.
173 Show the linear line of history of the current branch.
174 This option restricts history traversal to the first parent of each commit.
175 Commits which the branch was based on and merge commits which affected the
176 branch will be shown, but individual commits created on parallel branches
179 Start traversing history at the specified
181 The expected argument is the name of a branch or a commit ID SHA1 hash.
182 If this option is not specified, default to the work tree's current branch
183 if invoked in a work tree, or to the repository's HEAD reference.
185 Set the number of context lines shown in diffs with
187 By default, 3 lines of context are shown.
189 Limit history traversal to a given number of commits.
191 Display the patch of modifications made in each commit.
192 .It Fl r Ar repository-path
193 Use the repository at the specified path.
194 If not specified, assume the repository is located at or above the current
196 If this directory is a
198 work tree, use the repository path associated with this work tree.
200 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
201 When invoked within a work tree with less than two arguments, display
202 uncommitted changes in the work tree.
205 is specified, only show changes within this path.
207 If two arguments are provided, treat each argument as a reference,
208 or an object ID SHA1 hash, and display differences between these objects.
209 Both objects must be of the same type (blobs, trees, or commits).
216 Set the number of context lines shown in the diff.
217 By default, 3 lines of context are shown.
218 .It Fl r Ar repository-path
219 Use the repository at the specified path.
220 If not specified, assume the repository is located at or above the current
222 If this directory is a
224 work tree, use the repository path associated with this work tree.
226 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
227 Display line-by-line history of a file at the specified path.
234 Start traversing history at the specified
236 The expected argument is the name of a branch or a commit ID SHA1 hash.
237 .It Fl r Ar repository-path
238 Use the repository at the specified path.
239 If not specified, assume the repository is located at or above the current
241 If this directory is a
243 work tree, use the repository path associated with this work tree.
245 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
246 Display a listing of files and directories at the specified
247 directory path in the repository.
248 Entries shown in this listing may carry one of the following trailing
250 .Bl -column YXZ description
251 .It / Ta entry is a directory
252 .It * Ta entry is an executable file
257 is specified, list the repository path corresponding to the current
258 directory of the work tree, or the root directory of the repository
259 if there is no work tree.
266 List files and directories as they appear in the specified
268 The expected argument is the name of a branch or a commit ID SHA1 hash.
269 .It Fl r Ar repository-path
270 Use the repository at the specified path.
271 If not specified, assume the repository is located at or above the current
273 If this directory is a
275 work tree, use the repository path associated with this work tree.
277 Show object IDs of files (blob objects) and directories (tree objects).
279 Recurse into sub-directories in the repository.
281 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
282 Manage references in a repository.
284 If no options are passed, expect two arguments and attempt to create,
285 or update, the reference with the given
287 and make it point at the given
289 The target may be an object ID SHA1 hash or an existing reference which
290 will be resolved to an object ID.
296 .It Fl r Ar repository-path
297 Use the repository at the specified path.
298 If not specified, assume the repository is located at or above the current
300 If this directory is a
302 work tree, use the repository path associated with this work tree.
304 List all existing references in the repository.
306 Delete the reference with the specified name from the repository.
308 .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
309 Manage branches in a repository.
311 Branches are managed via references which live in the
316 command operates on references in this namespace only.
318 If no options are passed, expect one or two arguments and attempt to create
319 a branch with the given
321 and make it point at the given
325 is specified, default to the work tree's current branch if invoked in a
326 work tree, or to the repository's HEAD reference.
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 List all existing branches in the repository.
342 Delete the branch with the specified name from the repository.
344 .It Cm add Ar file-path ...
345 Schedule unversioned files in a work tree for addition to the
346 repository in the next commit.
347 .It Cm rm Ar file-path ...
348 Remove versioned files from a work tree and schedule them for deletion
349 from the repository in the next commit.
356 Perform the operation even if a file contains uncommitted modifications.
358 .It Cm revert Ar file-path ...
359 Revert any uncommited changes in files at the specified paths.
360 File contents will be overwritten with those contained in the
361 work tree's base commit. There is no way to bring discarded
365 If a file was added with
367 it will become an unversioned file again.
368 If a file was deleted with
371 .It Cm commit [ Fl m Ar msg ] [ file-path ]
372 Create a new commit in the repository from local changes in a work tree
373 and use this commit as the new base commit for the work tree.
375 Show the status of each affected file, using the following status codes:
376 .Bl -column YXZ description
377 .It M Ta modified file
378 .It D Ta file was deleted
379 .It A Ta new file was added
382 Files without local changes will retain their previously recorded base
386 commands may refuse to run while the work tree contains files from
387 multiple base commits.
388 The base commit of such a work tree can be made consistent by running
390 across the entire work tree.
396 environment variable to be set.
403 Use the specified log message when creating the new commit.
408 opens a temporary file in an editor where a log message can be written.
410 .It Cm cherrypick Ar commit
411 Merge changes from a single
416 must be on a different branch than the work tree's base commit.
417 The expected argument is a reference or a commit ID SHA1 hash.
419 Show the status of each affected file, using the following status codes:
420 .Bl -column YXZ description
421 .It G Ta file was merged
422 .It C Ta file was merged and conflicts occurred during merge
423 .It ! Ta changes destined for a missing file were not merged
424 .It D Ta file was deleted
425 .It d Ta file's deletion was obstructed by local modifications
426 .It A Ta new file was added
427 .It ~ Ta changes destined for a non-regular file were not merged
430 The merged changes will appear as local changes in the work tree, which
433 amended manually or with further
438 or discarded again with
442 will refuse to run if certain preconditions are not met.
443 If the work tree contains multiple base commits it must first be updated
444 to a single base commit with
446 If the work tree already contains files with merge conflicts, these
447 conflicts must be resolved first.
448 .It Cm backout Ar commit
449 Reverse-merge changes from a single
454 must be on the same branch as the work tree's base commit.
455 The expected argument is a reference or a commit ID SHA1 hash.
457 Show the status of each affected file, using the following status codes:
458 .Bl -column YXZ description
459 .It G Ta file was merged
460 .It C Ta file was merged and conflicts occurred during merge
461 .It ! Ta changes destined for a missing file were not merged
462 .It D Ta file was deleted
463 .It d Ta file's deletion was obstructed by local modifications
464 .It A Ta new file was added
465 .It ~ Ta changes destined for a non-regular file were not merged
468 The reverse-merged changes will appear as local changes in the work tree,
469 which may be viewed with
471 amended manually or with further
476 or discarded again with
480 will refuse to run if certain preconditions are not met.
481 If the work tree contains multiple base commits it must first be updated
482 to a single base commit with
484 If the work tree already contains files with merge conflicts, these
485 conflicts must be resolved first.
488 .Bl -tag -width GOT_AUTHOR
490 The author's name and email address for
493 .An Stefan Sperling Aq Mt stsp@openbsd.org
494 .It Ev VISUAL, Ev EDITOR
495 The editor spawned by
502 Clone an existing Git repository for use with
504 This step currently requires
508 .Dl $ git clone --bare https://github.com/openbsd/src.git
510 Check out a work tree from this Git repository to /usr/src:
512 .Dl $ got checkout /var/git/src.git /usr/src
514 View local changes in a work tree directory:
517 .Dl $ got diff | less
519 In a work tree or a git repository directory, list all branch references:
523 In a work tree or a git repository directory, create a new branch called
524 .Dq unified-buffer-cache
525 which is forked off the
529 .Dl $ got branch unified-buffer-cache master
531 Switch an existing work tree to the branch
532 .Dq unified-buffer-cache .
533 Local changes in the work tree will be preserved and merged if necessary:
535 .Dl $ got update -b unified-buffer-cache
537 Create a new commit from local changes in a work tree directory.
538 This new commit will become the head commit of the work tree's current branch:
542 In a work tree or a git repository directory, view changes committed in
543 the 3 most recent commits to the work tree's branch, or the branch resolved
544 via the repository's HEAD reference, respectively:
546 .Dl $ got log -p -l 3 -b
548 Add new files and remove obsolete files in a work tree directory:
550 .Dl $ got add sys/uvm/uvm_ubc.c
551 .Dl $ got rm sys/uvm/uvm_vnode.c
553 Create a new commit from local changes in a work tree directory
554 with a pre-defined log message.
556 .Dl $ got commit -m 'unify the buffer cache'
558 Update any work tree checked out from the
559 .Dq unified-buffer-cache
560 branch to the latest commit on this branch:
564 Fetch new upstream commits into the local repository's master branch.
565 This step currently requires
568 .Dl $ cd /var/git/src.git
569 .Dl $ git fetch origin master:master
572 .Dq unified-buffer-cache
573 branch on top of the new head commit of the
576 This step currently requires
579 .Dl $ git clone /var/git/src.git ~/src-git-wt
580 .Dl $ cd ~/src-git-wt
581 .Dl $ git checkout unified-buffer-cache
582 .Dl $ git rebase master
585 Update the work tree to the newly rebased
586 .Dq unified-buffer-cache
589 .Dl $ got update -b unified-buffer-cache
594 .An Stefan Sperling Aq Mt stsp@openbsd.org
595 .An Martin Pieuchot Aq Mt mpi@openbsd.org
596 .An joshua stein Aq Mt jcs@openbsd.org
599 is a work-in-progress and many commands remain to be implemented.
600 At present, the user has to fall back on
602 to perform many basic tasks.
604 When working against a repository created with
605 .Dq git clone --bare ,
608 branch are discouraged, for now, if changes committed to the upstream
609 repository need to be tracked.
610 See the EXAMPLES section.
