2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5d56da81 2019-01-13 stsp .\" Copyright (c) 2018, 2019 Stefan Sperling
5 5c860e29 2018-03-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
6 5c860e29 2018-03-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
7 5c860e29 2018-03-12 stsp .\" copyright notice and this permission notice appear in all copies.
9 5c860e29 2018-03-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 5c860e29 2018-03-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 5c860e29 2018-03-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 5c860e29 2018-03-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 5c860e29 2018-03-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 5c860e29 2018-03-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 5c860e29 2018-03-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 5c860e29 2018-03-12 stsp .Dd $Mdocdate$
22 eb7dbff5 2019-05-09 stsp .Nd game of trees
23 5c860e29 2018-03-12 stsp .Sh SYNOPSIS
27 5c860e29 2018-03-12 stsp .Op Ar arg ...
28 5c860e29 2018-03-12 stsp .Sh DESCRIPTION
30 4dfb2f0f 2019-03-26 stsp is a version control system which stores the history of tracked files
31 4dfb2f0f 2019-03-26 stsp in a Git repository, as used by the Git version control system.
32 285dc8a4 2018-03-13 stsp This repository format is described in
33 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
37 ae73e26f 2019-03-26 stsp .Dq distributed
38 4129c201 2018-03-13 stsp version control system because every copy of a repository is writeable.
39 4129c201 2018-03-13 stsp Modifications made to files can be synchronized between repositories
40 97925469 2018-03-17 stsp at any time.
42 285dc8a4 2018-03-13 stsp Files managed by
44 4129c201 2018-03-13 stsp must be checked out from the repository for modification.
45 285dc8a4 2018-03-13 stsp Checked out files are stored in a
46 285dc8a4 2018-03-13 stsp .Em work tree
47 c5867b47 2018-03-13 stsp which can be placed at an arbitrary directory in the filesystem hierarchy.
48 fb2921d0 2019-03-26 stsp The on-disk format of this work tree is described in
49 285dc8a4 2018-03-13 stsp .Xr got-worktree 5 .
52 285dc8a4 2018-03-13 stsp provides global and command-specific options.
53 285dc8a4 2018-03-13 stsp Global options must preceed the command name, and are as follows:
54 1b6b95a8 2018-03-12 stsp .Bl -tag -width tenletters
56 1b6b95a8 2018-03-12 stsp Display usage information.
59 38e11793 2018-06-13 stsp The commands for
61 38e11793 2018-06-13 stsp are as follows:
62 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
63 08573d5b 2019-05-14 stsp .It Cm checkout [ Fl b Ar branch ] [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
64 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
66 5d7c1dab 2018-04-01 stsp .Ar work tree path
67 c844a238 2019-02-06 stsp is not specified, either use the last component of
68 5d7c1dab 2018-04-01 stsp .Ar repository path ,
70 5d7c1dab 2018-04-01 stsp .Ar path prefix
71 c844a238 2019-02-06 stsp was specified use the last component of
72 5d7c1dab 2018-04-01 stsp .Ar path prefix .
74 38e11793 2018-06-13 stsp The options for
75 38e11793 2018-06-13 stsp .Cm got checkout
76 38e11793 2018-06-13 stsp are as follows:
77 38e11793 2018-06-13 stsp .Bl -tag -width Ds
78 08573d5b 2019-05-14 stsp .It Fl b Ar branch
79 08573d5b 2019-05-14 stsp Check out files from the specified
80 08573d5b 2019-05-14 stsp .Ar branch .
81 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
82 08573d5b 2019-05-14 stsp reference will be used.
83 8069f636 2019-01-12 stsp .It Fl c Ar commit
84 8069f636 2019-01-12 stsp Check out files from the specified
85 8069f636 2019-01-12 stsp .Ar commit .
86 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
87 08573d5b 2019-05-14 stsp branch will be used.
88 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
89 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
90 38e11793 2018-06-13 stsp Only files beneath the specified
91 38e11793 2018-06-13 stsp .Ar path-prefix
92 38e11793 2018-06-13 stsp will be checked out.
94 024e9686 2019-05-14 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ]
95 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
96 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
97 7f838b36 2019-02-08 stsp .Bl -column YXZ description
98 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
99 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
100 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
101 7f838b36 2019-02-08 stsp .It D Ta file was deleted
102 7f838b36 2019-02-08 stsp .It A Ta new file was added
103 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
104 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
109 c4cdcb68 2019-04-03 stsp is specified, restrict the update operation to files at or within this path.
110 f2cf8fbb 2019-04-04 stsp The path is required to exist in the update operation's target commit.
111 f2cf8fbb 2019-04-04 stsp Files in the work tree outside this path will remain unchanged and will
112 f2cf8fbb 2019-04-04 stsp retain their previously recorded base commit.
115 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
116 c4cdcb68 2019-04-03 stsp multiple base commits.
117 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
118 47ec7be7 2019-05-12 stsp .Cm got update
119 47ec7be7 2019-05-12 stsp across the entire work tree.
120 024e9686 2019-05-14 stsp Specifying a
122 024e9686 2019-05-14 stsp is incompatible with the
126 507dc3bb 2018-12-29 stsp The options for
127 507dc3bb 2018-12-29 stsp .Cm got update
128 507dc3bb 2018-12-29 stsp are as follows:
129 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
130 024e9686 2019-05-14 stsp .It Fl b Ar branch
131 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
133 024e9686 2019-05-14 stsp before updating the work tree.
134 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
135 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
136 507dc3bb 2018-12-29 stsp Update the work tree to the specified
137 507dc3bb 2018-12-29 stsp .Ar commit .
138 0032ca71 2019-01-23 stsp The expected argument is a SHA1 hash which corresponds to a commit object.
139 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
140 024e9686 2019-05-14 stsp branch will be used.
142 927df6b7 2019-02-10 stsp .It Cm status [ Ar path ]
143 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
144 6bad629b 2019-02-04 stsp using the following status codes:
145 6bad629b 2019-02-04 stsp .Bl -column YXZ description
146 6bad629b 2019-02-04 stsp .It M Ta modified file
147 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
148 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
149 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
150 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
151 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
152 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
158 927df6b7 2019-02-10 stsp is specified, only show modifications within this path.
159 ae9f01af 2018-10-18 stsp .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 ]
160 38e11793 2018-06-13 stsp Display history of a repository.
163 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
165 38e11793 2018-06-13 stsp The options for
166 38e11793 2018-06-13 stsp .Cm got log
167 38e11793 2018-06-13 stsp are as follows:
168 38e11793 2018-06-13 stsp .Bl -tag -width Ds
169 38e11793 2018-06-13 stsp .It Fl c Ar commit
170 38e11793 2018-06-13 stsp Start traversing history at the specified
171 38e11793 2018-06-13 stsp .Ar commit .
172 d1f2edc9 2018-06-13 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
173 1cfab718 2018-06-13 stsp to a commit object.
174 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
175 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
176 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
177 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
179 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
181 38e11793 2018-06-13 stsp Restrict history traversal to the first parent of each commit.
182 38e11793 2018-06-13 stsp This shows the linear history of the current branch only.
183 38e11793 2018-06-13 stsp Merge commits which affected the current branch will be shown but
184 38e11793 2018-06-13 stsp individual commits which originated on other branches will be omitted.
185 6238ee32 2018-06-13 stsp .It Fl l Ar N
186 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
188 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
189 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
190 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
191 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
192 04ca23f4 2018-07-16 stsp working directory.
193 e9cf2e30 2019-02-05 stsp If this directory is a
195 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
197 927df6b7 2019-02-10 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
198 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
199 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
202 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
204 927df6b7 2019-02-10 stsp If two arguments are provided, treat each argument as a SHA1 hash which
205 927df6b7 2019-02-10 stsp corresponds to an object in the repository, and display differences
206 927df6b7 2019-02-10 stsp between these objects.
207 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
209 c0cc5c62 2018-10-18 stsp The options for
210 c0cc5c62 2018-10-18 stsp .Cm got diff
211 c0cc5c62 2018-10-18 stsp are as follows:
212 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
213 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
214 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
215 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
216 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
217 b72f483a 2019-02-05 stsp Use the repository at the specified path.
218 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
219 b72f483a 2019-02-05 stsp working directory.
220 b72f483a 2019-02-05 stsp If this directory is a
222 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
224 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
225 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
227 1ff8e573 2018-08-02 stsp The options for
228 1ff8e573 2018-08-02 stsp .Cm got blame
229 1ff8e573 2018-08-02 stsp are as follows:
230 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
231 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
232 1ff8e573 2018-08-02 stsp Start traversing history at the specified
233 1ff8e573 2018-08-02 stsp .Ar commit .
234 1ff8e573 2018-08-02 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
235 1ff8e573 2018-08-02 stsp to a commit object.
236 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
237 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
238 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
239 1ff8e573 2018-08-02 stsp working directory.
240 0c06baac 2019-02-05 stsp If this directory is a
242 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
244 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
245 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
246 5de5890b 2018-10-18 stsp directory path in the repository.
247 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
248 db0c2996 2019-02-10 stsp annotations:
249 db0c2996 2019-02-10 stsp .Bl -column YXZ description
250 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
251 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
256 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
257 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
258 0c849583 2019-02-05 stsp if there is no work tree.
260 5de5890b 2018-10-18 stsp The options for
261 5de5890b 2018-10-18 stsp .Cm got tree
262 5de5890b 2018-10-18 stsp are as follows:
263 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
264 5de5890b 2018-10-18 stsp .It Fl c Ar commit
265 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
266 5de5890b 2018-10-18 stsp .Ar commit .
267 5de5890b 2018-10-18 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
268 5de5890b 2018-10-18 stsp to a commit object.
269 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
270 5de5890b 2018-10-18 stsp Use the repository at the specified path.
271 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
272 5de5890b 2018-10-18 stsp working directory.
273 0c849583 2019-02-05 stsp If this directory is a
275 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
277 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
279 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
281 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
282 d0eebce4 2019-03-11 stsp Manage references in a repository.
284 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
285 d0eebce4 2019-03-11 stsp or update, the reference with the given
287 d0eebce4 2019-03-11 stsp and make it point at the given
288 d83d9d5c 2019-05-13 stsp .Ar target .
289 d83d9d5c 2019-05-13 stsp The target may be a SHA1 hash which corresponds to an existing object ID
290 d83d9d5c 2019-05-13 stsp in the repository, or an existing reference which will be resolved to an
293 d0eebce4 2019-03-11 stsp The options for
294 d0eebce4 2019-03-11 stsp .Cm got ref
295 d0eebce4 2019-03-11 stsp are as follows:
296 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
297 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
298 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
299 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
300 d0eebce4 2019-03-11 stsp working directory.
301 d0eebce4 2019-03-11 stsp If this directory is a
303 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
305 d0eebce4 2019-03-11 stsp List all existing references in the repository.
306 d0eebce4 2019-03-11 stsp .It Fl d Ar name
307 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
309 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
310 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
311 d00136be 2019-03-26 stsp repository in the next commit.
312 2ec1f75b 2019-03-26 stsp .It Cm rm Ar file-path
313 2ec1f75b 2019-03-26 stsp Remove a versioned file from a work tree and schedule it for deletion
314 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
316 2ec1f75b 2019-03-26 stsp The options for
318 2ec1f75b 2019-03-26 stsp are as follows:
319 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
321 2ec1f75b 2019-03-26 stsp Perform the operation even if the file contains uncommitted modifications.
323 a129376b 2019-03-28 stsp .It Cm revert Ar file-path
324 a129376b 2019-03-28 stsp Revert any uncommited changes in the file at the specified path.
325 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
326 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
327 a129376b 2019-03-28 stsp changes back after
328 a129376b 2019-03-28 stsp .Cm got revert !
330 a129376b 2019-03-28 stsp If the file was added with
331 a129376b 2019-03-28 stsp .Cm got add
332 a129376b 2019-03-28 stsp it will become an unversioned file again.
333 a129376b 2019-03-28 stsp If the file was deleted with
335 a129376b 2019-03-28 stsp it will be restored.
336 74416c47 2019-05-09 stsp .It Cm commit [ Fl m Ar msg ] [ file-path ]
337 15cd91f7 2019-05-12 stsp Create a new commit in the repository from local changes in a work tree
338 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
340 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
341 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
342 15cd91f7 2019-05-12 stsp .It M Ta modified file
343 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
344 15cd91f7 2019-05-12 stsp .It A Ta new file was added
347 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
351 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
352 15cd91f7 2019-05-12 stsp multiple base commits.
353 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
354 47ec7be7 2019-05-12 stsp .Cm got update
355 47ec7be7 2019-05-12 stsp across the entire work tree.
358 15cd91f7 2019-05-12 stsp .Cm got commit
359 15cd91f7 2019-05-12 stsp command requires the
360 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
361 74416c47 2019-05-09 stsp environment variable to be set.
363 74416c47 2019-05-09 stsp The options for
364 74416c47 2019-05-09 stsp .Cm got commit
365 74416c47 2019-05-09 stsp are as follows:
366 74416c47 2019-05-09 stsp .Bl -tag -width Ds
367 74416c47 2019-05-09 stsp .It Fl m Ar msg
368 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
369 23594da9 2019-05-13 stsp Without the
372 23594da9 2019-05-13 stsp .Cm got commit
373 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
376 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
377 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
378 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
379 74416c47 2019-05-09 stsp The author's name and email address for
380 74416c47 2019-05-09 stsp .Cm got commit ,
381 74416c47 2019-05-09 stsp for example:
382 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
383 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
384 23594da9 2019-05-13 stsp The editor spawned by
385 23594da9 2019-05-13 stsp .Cm got commit .
387 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
388 5c860e29 2018-03-12 stsp .Ex -std got
389 97925469 2018-03-17 stsp .Sh EXAMPLES
390 97925469 2018-03-17 stsp Check out a work tree of
392 97925469 2018-03-17 stsp kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
394 97925469 2018-03-17 stsp .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
396 d83d9d5c 2019-05-13 stsp Create a new branch
397 d83d9d5c 2019-05-13 stsp .Dq mybranch
398 d83d9d5c 2019-05-13 stsp which is forked off the
402 eb6c77f2 2019-05-13 stsp .Dl $ got ref refs/heads/mybranch refs/heads/master
403 5c860e29 2018-03-12 stsp .Sh SEE ALSO
404 5e5560e1 2018-08-01 stsp .Xr git-repository 5
405 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
406 1a208aaf 2018-04-01 stsp .Sh AUTHORS
407 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
408 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
409 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
