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.
22 .Nd version control system
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 checkout [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
64 Copy files from a repository into a new work tree.
67 is not specified, either use the last component of
71 was specified use the last component of
79 Check out files from the specified
81 If this option is not specified, a commit resolved via the repository's HEAD
82 reference will be used.
83 .It Fl p Ar path-prefix
84 Restrict the work tree to a subset of the repository's tree hierarchy.
85 Only files beneath the specified
89 .It Cm update [ Fl c Ar commit ] [ Ar path ]
90 Update an existing work tree to another commit on the current branch.
91 By default, the latest commit on the current branch is assumed.
92 Show the status of each affected file, using the following status codes:
93 .Bl -column YXZ description
94 .It U Ta file was updated and contained no local changes
95 .It G Ta file was updated and local changes were merged cleanly
96 .It C Ta file was updated and conflicts occurred during merge
97 .It D Ta file was deleted
98 .It A Ta new file was added
99 .It ~ Ta versioned file is obstructed by a non-regular file
100 .It ! Ta a missing versioned file was restored
105 is specified, restrict the update operation to files at or within this path.
106 The path is required to exist in the update operation's target commit.
107 Files in the work tree outside this path will remain unchanged and will
108 retain their previously recorded base commit.
111 commands may refuse to run while the work tree contains files from
112 multiple base commits.
113 The base commit of such a work tree can be made consistent by running
114 another update operation across the entire work tree.
121 Update the work tree to the specified
123 The expected argument is a SHA1 hash which corresponds to a commit object.
125 .It Cm status [ Ar path ]
126 Show the current modification status of files in a work tree,
127 using the following status codes:
128 .Bl -column YXZ description
129 .It M Ta modified file
130 .It A Ta file scheduled for addition in next commit
131 .It D Ta file scheduled for deletion in next commit
132 .It C Ta modified or added file which contains merge conflicts
133 .It ! Ta versioned file was expected on disk but is missing
134 .It ~ Ta versioned file is obstructed by a non-regular file
135 .It ? Ta unversioned item not tracked by
141 is specified, only show modifications within this path.
142 .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 ]
143 Display history of a repository.
146 is specified, show only commits which modified this path.
153 Start traversing history at the specified
155 The expected argument is the name of a branch or a SHA1 hash which corresponds
158 Set the number of context lines shown in diffs with
160 By default, 3 lines of context are shown.
162 Restrict history traversal to the first parent of each commit.
163 This shows the linear history of the current branch only.
164 Merge commits which affected the current branch will be shown but
165 individual commits which originated on other branches will be omitted.
167 Limit history traversal to a given number of commits.
169 Display the patch of modifications made in each commit.
170 .It Fl r Ar repository-path
171 Use the repository at the specified path.
172 If not specified, assume the repository is located at or above the current
174 If this directory is a
176 work tree, use the repository path associated with this work tree.
178 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
179 When invoked within a work tree with less than two arguments, display
180 uncommitted changes in the work tree.
183 is specified, only show changes within this path.
185 If two arguments are provided, treat each argument as a SHA1 hash which
186 corresponds to an object in the repository, and display differences
187 between these objects.
188 Both objects must be of the same type (blobs, trees, or commits).
195 Set the number of context lines shown in the diff.
196 By default, 3 lines of context are shown.
197 .It Fl r Ar repository-path
198 Use the repository at the specified path.
199 If not specified, assume the repository is located at or above the current
201 If this directory is a
203 work tree, use the repository path associated with this work tree.
205 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
206 Display line-by-line history of a file at the specified path.
213 Start traversing history at the specified
215 The expected argument is the name of a branch or a SHA1 hash which corresponds
217 .It Fl r Ar repository-path
218 Use the repository at the specified path.
219 If not specified, assume the repository is located at or above the current
221 If this directory is a
223 work tree, use the repository path associated with this work tree.
225 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
226 Display a listing of files and directories at the specified
227 directory path in the repository.
228 Entries shown in this listing may carry one of the following trailing
230 .Bl -column YXZ description
231 .It / Ta entry is a directory
232 .It * Ta entry is an executable file
237 is specified, list the repository path corresponding to the current
238 directory of the work tree, or the root directory of the repository
239 if there is no work tree.
246 List files and directories as they appear in the specified
248 The expected argument is the name of a branch or a SHA1 hash which corresponds
250 .It Fl r Ar repository-path
251 Use the repository at the specified path.
252 If not specified, assume the repository is located at or above the current
254 If this directory is a
256 work tree, use the repository path associated with this work tree.
258 Show object IDs of files (blob objects) and directories (tree objects).
260 Recurse into sub-directories in the repository.
262 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar object ]
263 Manage references in a repository.
265 If no options are passed, expect two arguments and attempt to create,
266 or update, the reference with the given
268 and make it point at the given
270 The object argument is a SHA1 hash which corresponds to an existing
271 object in the repository.
277 .It Fl r Ar repository-path
278 Use the repository at the specified path.
279 If not specified, assume the repository is located at or above the current
281 If this directory is a
283 work tree, use the repository path associated with this work tree.
285 List all existing references in the repository.
287 Delete the reference with the specified name from the repository.
289 .It Cm add Ar file-path
290 Schedule an unversioned file in a work tree for addition to the
291 repository in the next commit.
292 .It Cm rm Ar file-path
293 Remove a versioned file from a work tree and schedule it for deletion
294 from the repository in the next commit.
301 Perform the operation even if the file contains uncommitted modifications.
303 .It Cm revert Ar file-path
304 Revert any uncommited changes in the file at the specified path.
305 File contents will be overwritten with those contained in the
306 work tree's base commit. There is no way to bring discarded
310 If the file was added with
312 it will become an unversioned file again.
313 If the file was deleted with
320 Check out a work tree of
322 kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
324 .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
329 .An Stefan Sperling Aq Mt stsp@openbsd.org
330 .An Martin Pieuchot Aq Mt mpi@openbsd.org
