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 An abbreviated hash argument will be expanded to a full SHA1 hash
143 automatically, provided the abbreviation is unique.
144 If this option is not specified, the most recent commit on the work tree's
147 .It Cm status [ Ar path ]
148 Show the current modification status of files in a work tree,
149 using the following status codes:
150 .Bl -column YXZ description
151 .It M Ta modified file
152 .It A Ta file scheduled for addition in next commit
153 .It D Ta file scheduled for deletion in next commit
154 .It C Ta modified or added file which contains merge conflicts
155 .It ! Ta versioned file was expected on disk but is missing
156 .It ~ Ta versioned file is obstructed by a non-regular file
157 .It ? Ta unversioned item not tracked by
163 is specified, only show modifications within this path.
164 .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 ]
165 Display history of a repository.
168 is specified, show only commits which modified this path.
175 Show the linear line of history of the current branch.
176 This option restricts history traversal to the first parent of each commit.
177 Commits which the branch was based on and merge commits which affected the
178 branch will be shown, but individual commits created on parallel branches
181 Start traversing history at the specified
183 The expected argument is the name of a branch or a commit ID SHA1 hash.
184 An abbreviated hash argument will be expanded to a full SHA1 hash
185 automatically, provided the abbreviation is unique.
186 If this option is not specified, default to the work tree's current branch
187 if invoked in a work tree, or to the repository's HEAD reference.
189 Set the number of context lines shown in diffs with
191 By default, 3 lines of context are shown.
193 Limit history traversal to a given number of commits.
195 Display the patch of modifications made in each commit.
196 .It Fl r Ar repository-path
197 Use the repository at the specified path.
198 If not specified, assume the repository is located at or above the current
200 If this directory is a
202 work tree, use the repository path associated with this work tree.
204 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
205 When invoked within a work tree with less than two arguments, display
206 uncommitted changes in the work tree.
209 is specified, only show changes within this path.
211 If two arguments are provided, treat each argument as a reference,
212 or an object ID SHA1 hash, and display differences between these objects.
213 Both objects must be of the same type (blobs, trees, or commits).
214 An abbreviated hash argument will be expanded to a full SHA1 hash
215 automatically, provided the abbreviation is unique.
222 Set the number of context lines shown in the diff.
223 By default, 3 lines of context are shown.
224 .It Fl r Ar repository-path
225 Use the repository at the specified path.
226 If not specified, assume the repository is located at or above the current
228 If this directory is a
230 work tree, use the repository path associated with this work tree.
232 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
233 Display line-by-line history of a file at the specified path.
240 Start traversing history at the specified
242 The expected argument is the name of a branch or a commit ID SHA1 hash.
243 An abbreviated hash argument will be expanded to a full SHA1 hash
244 automatically, provided the abbreviation is unique.
245 .It Fl r Ar repository-path
246 Use the repository at the specified path.
247 If not specified, assume the repository is located at or above the current
249 If this directory is a
251 work tree, use the repository path associated with this work tree.
253 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
254 Display a listing of files and directories at the specified
255 directory path in the repository.
256 Entries shown in this listing may carry one of the following trailing
258 .Bl -column YXZ description
259 .It / Ta entry is a directory
260 .It * Ta entry is an executable file
265 is specified, list the repository path corresponding to the current
266 directory of the work tree, or the root directory of the repository
267 if there is no work tree.
274 List files and directories as they appear in the specified
276 The expected argument is the name of a branch or a commit ID SHA1 hash.
277 An abbreviated hash argument will be expanded to a full SHA1 hash
278 automatically, provided the abbreviation is unique.
279 .It Fl r Ar repository-path
280 Use the repository at the specified path.
281 If not specified, assume the repository is located at or above the current
283 If this directory is a
285 work tree, use the repository path associated with this work tree.
287 Show object IDs of files (blob objects) and directories (tree objects).
289 Recurse into sub-directories in the repository.
291 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
292 Manage references in a repository.
294 If no options are passed, expect two arguments and attempt to create,
295 or update, the reference with the given
297 and make it point at the given
299 The target may be an object ID SHA1 hash or an existing reference which
300 will be resolved to an object ID.
301 An abbreviated hash argument will be expanded to a full SHA1 hash
302 automatically, provided the abbreviation is unique.
308 .It Fl r Ar repository-path
309 Use the repository at the specified path.
310 If not specified, assume the repository is located at or above the current
312 If this directory is a
314 work tree, use the repository path associated with this work tree.
316 List all existing references in the repository.
318 Delete the reference with the specified name from the repository.
320 .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
321 Manage branches in a repository.
323 Branches are managed via references which live in the
328 command operates on references in this namespace only.
330 If no options are passed, expect one or two arguments and attempt to create
331 a branch with the given
333 and make it point at the given
337 is specified, default to the work tree's current branch if invoked in a
338 work tree, or to the repository's HEAD reference.
344 .It Fl r Ar repository-path
345 Use the repository at the specified path.
346 If not specified, assume the repository is located at or above the current
348 If this directory is a
350 work tree, use the repository path associated with this work tree.
352 List all existing branches in the repository.
354 Delete the branch with the specified name from the repository.
356 .It Cm add Ar file-path ...
357 Schedule unversioned files in a work tree for addition to the
358 repository in the next commit.
359 .It Cm rm Ar file-path ...
360 Remove versioned files from a work tree and schedule them for deletion
361 from the repository in the next commit.
368 Perform the operation even if a file contains uncommitted modifications.
370 .It Cm revert Ar file-path ...
371 Revert any uncommited changes in files at the specified paths.
372 File contents will be overwritten with those contained in the
373 work tree's base commit. There is no way to bring discarded
377 If a file was added with
379 it will become an unversioned file again.
380 If a file was deleted with
383 .It Cm commit [ Fl m Ar msg ] [ file-path ]
384 Create a new commit in the repository from local changes in a work tree
385 and use this commit as the new base commit for the work tree.
387 Show the status of each affected file, using the following status codes:
388 .Bl -column YXZ description
389 .It M Ta modified file
390 .It D Ta file was deleted
391 .It A Ta new file was added
394 Files without local changes will retain their previously recorded base
398 commands may refuse to run while the work tree contains files from
399 multiple base commits.
400 The base commit of such a work tree can be made consistent by running
402 across the entire work tree.
408 environment variable to be set.
415 Use the specified log message when creating the new commit.
420 opens a temporary file in an editor where a log message can be written.
422 .It Cm cherrypick Ar commit
423 Merge changes from a single
428 must be on a different branch than the work tree's base commit.
429 The expected argument is a reference or a commit ID SHA1 hash.
430 An abbreviated hash argument will be expanded to a full SHA1 hash
431 automatically, provided the abbreviation is unique.
433 Show the status of each affected file, using the following status codes:
434 .Bl -column YXZ description
435 .It G Ta file was merged
436 .It C Ta file was merged and conflicts occurred during merge
437 .It ! Ta changes destined for a missing file were not merged
438 .It D Ta file was deleted
439 .It d Ta file's deletion was obstructed by local modifications
440 .It A Ta new file was added
441 .It ~ Ta changes destined for a non-regular file were not merged
444 The merged changes will appear as local changes in the work tree, which
447 amended manually or with further
452 or discarded again with
456 will refuse to run if certain preconditions are not met.
457 If the work tree contains multiple base commits it must first be updated
458 to a single base commit with
460 If the work tree already contains files with merge conflicts, these
461 conflicts must be resolved first.
462 .It Cm backout Ar commit
463 Reverse-merge changes from a single
468 must be on the same branch as the work tree's base commit.
469 The expected argument is a reference or a commit ID SHA1 hash.
470 An abbreviated hash argument will be expanded to a full SHA1 hash
471 automatically, provided the abbreviation is unique.
473 Show the status of each affected file, using the following status codes:
474 .Bl -column YXZ description
475 .It G Ta file was merged
476 .It C Ta file was merged and conflicts occurred during merge
477 .It ! Ta changes destined for a missing file were not merged
478 .It D Ta file was deleted
479 .It d Ta file's deletion was obstructed by local modifications
480 .It A Ta new file was added
481 .It ~ Ta changes destined for a non-regular file were not merged
484 The reverse-merged changes will appear as local changes in the work tree,
485 which may be viewed with
487 amended manually or with further
492 or discarded again with
496 will refuse to run if certain preconditions are not met.
497 If the work tree contains multiple base commits it must first be updated
498 to a single base commit with
500 If the work tree already contains files with merge conflicts, these
501 conflicts must be resolved first.
504 .Bl -tag -width GOT_AUTHOR
506 The author's name and email address for
509 .An Stefan Sperling Aq Mt stsp@openbsd.org
510 .It Ev VISUAL, Ev EDITOR
511 The editor spawned by
518 Clone an existing Git repository for use with
520 This step currently requires
524 .Dl $ git clone --bare https://github.com/openbsd/src.git
526 Check out a work tree from this Git repository to /usr/src:
528 .Dl $ got checkout /var/git/src.git /usr/src
530 View local changes in a work tree directory:
533 .Dl $ got diff | less
535 In a work tree or a git repository directory, list all branch references:
539 In a work tree or a git repository directory, create a new branch called
540 .Dq unified-buffer-cache
541 which is forked off the
545 .Dl $ got branch unified-buffer-cache master
547 Switch an existing work tree to the branch
548 .Dq unified-buffer-cache .
549 Local changes in the work tree will be preserved and merged if necessary:
551 .Dl $ got update -b unified-buffer-cache
553 Create a new commit from local changes in a work tree directory.
554 This new commit will become the head commit of the work tree's current branch:
558 In a work tree or a git repository directory, view changes committed in
559 the 3 most recent commits to the work tree's branch, or the branch resolved
560 via the repository's HEAD reference, respectively:
562 .Dl $ got log -p -l 3 -b
564 Add new files and remove obsolete files in a work tree directory:
566 .Dl $ got add sys/uvm/uvm_ubc.c
567 .Dl $ got rm sys/uvm/uvm_vnode.c
569 Create a new commit from local changes in a work tree directory
570 with a pre-defined log message.
572 .Dl $ got commit -m 'unify the buffer cache'
574 Update any work tree checked out from the
575 .Dq unified-buffer-cache
576 branch to the latest commit on this branch:
580 Fetch new upstream commits into the local repository's master branch.
581 This step currently requires
584 .Dl $ cd /var/git/src.git
585 .Dl $ git fetch origin master:master
588 .Dq unified-buffer-cache
589 branch on top of the new head commit of the
592 This step currently requires
595 .Dl $ git clone /var/git/src.git ~/src-git-wt
596 .Dl $ cd ~/src-git-wt
597 .Dl $ git checkout unified-buffer-cache
598 .Dl $ git rebase master
601 Update the work tree to the newly rebased
602 .Dq unified-buffer-cache
605 .Dl $ got update -b unified-buffer-cache
610 .An Stefan Sperling Aq Mt stsp@openbsd.org
611 .An Martin Pieuchot Aq Mt mpi@openbsd.org
612 .An joshua stein Aq Mt jcs@openbsd.org
615 is a work-in-progress and many commands remain to be implemented.
616 At present, the user has to fall back on
618 to perform many basic tasks.
620 When working against a repository created with
621 .Dq git clone --bare ,
624 branch are discouraged, for now, if changes committed to the upstream
625 repository need to be tracked.
626 See the EXAMPLES section.
