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 2c7829a4 2019-06-17 stsp .It Cm init Ar path
64 2c7829a4 2019-06-17 stsp Create a new empty repository at the specified
66 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 ]
67 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
69 5d7c1dab 2018-04-01 stsp .Ar work tree path
70 c844a238 2019-02-06 stsp is not specified, either use the last component of
71 5d7c1dab 2018-04-01 stsp .Ar repository path ,
73 5d7c1dab 2018-04-01 stsp .Ar path prefix
74 c844a238 2019-02-06 stsp was specified use the last component of
75 5d7c1dab 2018-04-01 stsp .Ar path prefix .
77 38e11793 2018-06-13 stsp The options for
78 38e11793 2018-06-13 stsp .Cm got checkout
79 38e11793 2018-06-13 stsp are as follows:
80 38e11793 2018-06-13 stsp .Bl -tag -width Ds
81 08573d5b 2019-05-14 stsp .It Fl b Ar branch
82 08573d5b 2019-05-14 stsp Check out files from the specified
83 08573d5b 2019-05-14 stsp .Ar branch .
84 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
85 08573d5b 2019-05-14 stsp reference will be used.
86 8069f636 2019-01-12 stsp .It Fl c Ar commit
87 8069f636 2019-01-12 stsp Check out files from the specified
88 8069f636 2019-01-12 stsp .Ar commit .
89 0e1b0230 2019-07-07 stsp The expected argument is a commit ID SHA1 hash.
90 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
91 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
92 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
93 08573d5b 2019-05-14 stsp branch will be used.
94 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
95 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
96 38e11793 2018-06-13 stsp Only files beneath the specified
97 38e11793 2018-06-13 stsp .Ar path-prefix
98 38e11793 2018-06-13 stsp will be checked out.
100 024e9686 2019-05-14 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ]
101 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
102 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
103 7f838b36 2019-02-08 stsp .Bl -column YXZ description
104 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
105 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
106 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
107 7f838b36 2019-02-08 stsp .It D Ta file was deleted
108 7f838b36 2019-02-08 stsp .It A Ta new file was added
109 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
110 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
115 c4cdcb68 2019-04-03 stsp is specified, restrict the update operation to files at or within this path.
116 f2cf8fbb 2019-04-04 stsp The path is required to exist in the update operation's target commit.
117 f2cf8fbb 2019-04-04 stsp Files in the work tree outside this path will remain unchanged and will
118 f2cf8fbb 2019-04-04 stsp retain their previously recorded base commit.
121 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
122 c4cdcb68 2019-04-03 stsp multiple base commits.
123 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
124 47ec7be7 2019-05-12 stsp .Cm got update
125 47ec7be7 2019-05-12 stsp across the entire work tree.
126 024e9686 2019-05-14 stsp Specifying a
128 024e9686 2019-05-14 stsp is incompatible with the
132 507dc3bb 2018-12-29 stsp The options for
133 507dc3bb 2018-12-29 stsp .Cm got update
134 507dc3bb 2018-12-29 stsp are as follows:
135 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
136 024e9686 2019-05-14 stsp .It Fl b Ar branch
137 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
139 024e9686 2019-05-14 stsp before updating the work tree.
140 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
141 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
142 507dc3bb 2018-12-29 stsp Update the work tree to the specified
143 507dc3bb 2018-12-29 stsp .Ar commit .
144 a54b6686 2019-06-28 stsp The expected argument is a commit ID SHA1 hash.
145 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
146 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
147 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
148 024e9686 2019-05-14 stsp branch will be used.
150 927df6b7 2019-02-10 stsp .It Cm status [ Ar path ]
151 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
152 6bad629b 2019-02-04 stsp using the following status codes:
153 6bad629b 2019-02-04 stsp .Bl -column YXZ description
154 6bad629b 2019-02-04 stsp .It M Ta modified file
155 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
156 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
157 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
158 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
159 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
160 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
166 927df6b7 2019-02-10 stsp is specified, only show modifications within this path.
167 499d7ecc 2019-05-22 stsp .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 ]
168 38e11793 2018-06-13 stsp Display history of a repository.
171 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
173 38e11793 2018-06-13 stsp The options for
174 38e11793 2018-06-13 stsp .Cm got log
175 38e11793 2018-06-13 stsp are as follows:
176 38e11793 2018-06-13 stsp .Bl -tag -width Ds
178 43205691 2019-05-22 stsp Show the linear line of history of the current branch.
179 43205691 2019-05-22 stsp This option restricts history traversal to the first parent of each commit.
180 43205691 2019-05-22 stsp Commits which the branch was based on and merge commits which affected the
181 43205691 2019-05-22 stsp branch will be shown, but individual commits created on parallel branches
182 43205691 2019-05-22 stsp will be omitted.
183 38e11793 2018-06-13 stsp .It Fl c Ar commit
184 38e11793 2018-06-13 stsp Start traversing history at the specified
185 38e11793 2018-06-13 stsp .Ar commit .
186 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
187 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
188 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
189 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
190 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
191 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
192 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
194 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
195 6238ee32 2018-06-13 stsp .It Fl l Ar N
196 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
198 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
199 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
200 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
201 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
202 04ca23f4 2018-07-16 stsp working directory.
203 e9cf2e30 2019-02-05 stsp If this directory is a
205 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
207 927df6b7 2019-02-10 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
208 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
209 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
212 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
214 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
215 a54b6686 2019-06-28 stsp or an object ID SHA1 hash, and display differences between these objects.
216 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
217 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
218 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
220 c0cc5c62 2018-10-18 stsp The options for
221 c0cc5c62 2018-10-18 stsp .Cm got diff
222 c0cc5c62 2018-10-18 stsp are as follows:
223 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
224 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
225 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
226 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
227 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
228 b72f483a 2019-02-05 stsp Use the repository at the specified path.
229 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
230 b72f483a 2019-02-05 stsp working directory.
231 b72f483a 2019-02-05 stsp If this directory is a
233 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
235 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
236 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
238 1ff8e573 2018-08-02 stsp The options for
239 1ff8e573 2018-08-02 stsp .Cm got blame
240 1ff8e573 2018-08-02 stsp are as follows:
241 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
242 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
243 1ff8e573 2018-08-02 stsp Start traversing history at the specified
244 1ff8e573 2018-08-02 stsp .Ar commit .
245 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
246 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
247 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
248 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
249 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
250 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
251 1ff8e573 2018-08-02 stsp working directory.
252 0c06baac 2019-02-05 stsp If this directory is a
254 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
256 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
257 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
258 5de5890b 2018-10-18 stsp directory path in the repository.
259 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
260 db0c2996 2019-02-10 stsp annotations:
261 db0c2996 2019-02-10 stsp .Bl -column YXZ description
262 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
263 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
268 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
269 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
270 0c849583 2019-02-05 stsp if there is no work tree.
272 5de5890b 2018-10-18 stsp The options for
273 5de5890b 2018-10-18 stsp .Cm got tree
274 5de5890b 2018-10-18 stsp are as follows:
275 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
276 5de5890b 2018-10-18 stsp .It Fl c Ar commit
277 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
278 5de5890b 2018-10-18 stsp .Ar commit .
279 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
280 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
281 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
282 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
283 5de5890b 2018-10-18 stsp Use the repository at the specified path.
284 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
285 5de5890b 2018-10-18 stsp working directory.
286 0c849583 2019-02-05 stsp If this directory is a
288 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
290 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
292 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
294 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
295 d0eebce4 2019-03-11 stsp Manage references in a repository.
297 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
298 d0eebce4 2019-03-11 stsp or update, the reference with the given
300 d0eebce4 2019-03-11 stsp and make it point at the given
301 d83d9d5c 2019-05-13 stsp .Ar target .
302 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
303 a54b6686 2019-06-28 stsp will be resolved to an object ID.
304 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
305 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
307 d0eebce4 2019-03-11 stsp The options for
308 d0eebce4 2019-03-11 stsp .Cm got ref
309 d0eebce4 2019-03-11 stsp are as follows:
310 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
311 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
312 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
313 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
314 d0eebce4 2019-03-11 stsp working directory.
315 d0eebce4 2019-03-11 stsp If this directory is a
317 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
319 d0eebce4 2019-03-11 stsp List all existing references in the repository.
320 d0eebce4 2019-03-11 stsp .It Fl d Ar name
321 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
323 4e759de4 2019-06-26 stsp .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
324 4e759de4 2019-06-26 stsp Manage branches in a repository.
326 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
327 4e759de4 2019-06-26 stsp .Dq refs/heads/
328 4e759de4 2019-06-26 stsp reference namespace.
330 4e759de4 2019-06-26 stsp .Cm got branch
331 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
333 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
334 4e759de4 2019-06-26 stsp a branch with the given
336 4e759de4 2019-06-26 stsp and make it point at the given
337 4e759de4 2019-06-26 stsp .Ar base-branch .
339 4e759de4 2019-06-26 stsp .Ar base-branch
340 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
341 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
343 4e759de4 2019-06-26 stsp The options for
344 4e759de4 2019-06-26 stsp .Cm got branch
345 4e759de4 2019-06-26 stsp are as follows:
346 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
347 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
348 4e759de4 2019-06-26 stsp Use the repository at the specified path.
349 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
350 4e759de4 2019-06-26 stsp working directory.
351 4e759de4 2019-06-26 stsp If this directory is a
353 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
355 4e759de4 2019-06-26 stsp List all existing branches in the repository.
356 4e759de4 2019-06-26 stsp .It Fl d Ar name
357 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
359 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
360 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
361 d00136be 2019-03-26 stsp repository in the next commit.
362 17ed4618 2019-06-02 stsp .It Cm rm Ar file-path ...
363 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
364 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
366 2ec1f75b 2019-03-26 stsp The options for
368 2ec1f75b 2019-03-26 stsp are as follows:
369 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
371 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
373 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
374 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
375 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
376 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
377 a129376b 2019-03-28 stsp changes back after
378 a129376b 2019-03-28 stsp .Cm got revert !
380 e20a8b6f 2019-06-04 stsp If a file was added with
381 a129376b 2019-03-28 stsp .Cm got add
382 a129376b 2019-03-28 stsp it will become an unversioned file again.
383 e20a8b6f 2019-06-04 stsp If a file was deleted with
385 a129376b 2019-03-28 stsp it will be restored.
386 74ff3f23 2019-07-07 stsp .It Cm commit [ Fl m Ar message ] [ file-path ]
387 15cd91f7 2019-05-12 stsp Create a new commit in the repository from local changes in a work tree
388 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
390 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
391 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
392 15cd91f7 2019-05-12 stsp .It M Ta modified file
393 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
394 15cd91f7 2019-05-12 stsp .It A Ta new file was added
397 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
401 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
402 15cd91f7 2019-05-12 stsp multiple base commits.
403 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
404 47ec7be7 2019-05-12 stsp .Cm got update
405 47ec7be7 2019-05-12 stsp across the entire work tree.
408 15cd91f7 2019-05-12 stsp .Cm got commit
409 15cd91f7 2019-05-12 stsp command requires the
410 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
411 74416c47 2019-05-09 stsp environment variable to be set.
413 74416c47 2019-05-09 stsp The options for
414 74416c47 2019-05-09 stsp .Cm got commit
415 74416c47 2019-05-09 stsp are as follows:
416 74416c47 2019-05-09 stsp .Bl -tag -width Ds
417 74ff3f23 2019-07-07 stsp .It Fl m Ar message
418 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
419 23594da9 2019-05-13 stsp Without the
422 23594da9 2019-05-13 stsp .Cm got commit
423 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
425 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
426 234035bc 2019-06-01 stsp Merge changes from a single
428 234035bc 2019-06-01 stsp into the work tree.
429 234035bc 2019-06-01 stsp The specified
431 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
432 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
433 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
434 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
436 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
437 234035bc 2019-06-01 stsp .Bl -column YXZ description
438 234035bc 2019-06-01 stsp .It G Ta file was merged
439 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
440 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
441 234035bc 2019-06-01 stsp .It D Ta file was deleted
442 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
443 234035bc 2019-06-01 stsp .It A Ta new file was added
444 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
447 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
448 234035bc 2019-06-01 stsp may be viewed with
449 234035bc 2019-06-01 stsp .Cm got diff ,
450 234035bc 2019-06-01 stsp amended manually or with further
451 234035bc 2019-06-01 stsp .Cm got cherrypick
453 234035bc 2019-06-01 stsp committed with
454 234035bc 2019-06-01 stsp .Cm got commit ,
455 234035bc 2019-06-01 stsp or discarded again with
456 234035bc 2019-06-01 stsp .Cm got revert .
458 234035bc 2019-06-01 stsp .Cm got cherrypick
459 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
460 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
461 234035bc 2019-06-01 stsp to a single base commit with
462 234035bc 2019-06-01 stsp .Cm got update .
463 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
464 234035bc 2019-06-01 stsp conflicts must be resolved first.
465 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
466 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
468 5ef14e63 2019-06-02 stsp into the work tree.
469 5ef14e63 2019-06-02 stsp The specified
471 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
472 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
473 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
474 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
476 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
477 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
478 5ef14e63 2019-06-02 stsp .It G Ta file was merged
479 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
480 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
481 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
482 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
483 5ef14e63 2019-06-02 stsp .It A Ta new file was added
484 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
487 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
488 5ef14e63 2019-06-02 stsp which may be viewed with
489 5ef14e63 2019-06-02 stsp .Cm got diff ,
490 5ef14e63 2019-06-02 stsp amended manually or with further
491 5ef14e63 2019-06-02 stsp .Cm got cherrypick
493 5ef14e63 2019-06-02 stsp committed with
494 5ef14e63 2019-06-02 stsp .Cm got commit ,
495 5ef14e63 2019-06-02 stsp or discarded again with
496 5ef14e63 2019-06-02 stsp .Cm got revert .
498 92228c38 2019-06-02 stsp .Cm got backout
499 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
500 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
501 92228c38 2019-06-02 stsp to a single base commit with
502 92228c38 2019-06-02 stsp .Cm got update .
503 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
504 92228c38 2019-06-02 stsp conflicts must be resolved first.
506 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
507 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
508 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
509 74416c47 2019-05-09 stsp The author's name and email address for
510 74416c47 2019-05-09 stsp .Cm got commit ,
511 74416c47 2019-05-09 stsp for example:
512 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
513 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
514 23594da9 2019-05-13 stsp The editor spawned by
515 23594da9 2019-05-13 stsp .Cm got commit .
517 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
518 5c860e29 2018-03-12 stsp .Ex -std got
519 97925469 2018-03-17 stsp .Sh EXAMPLES
521 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
523 fa6e0e48 2019-05-23 stsp This step currently requires
524 fa6e0e48 2019-05-23 stsp .Xr git 1 :
526 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
527 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
529 fa6e0e48 2019-05-23 stsp Check out a work tree from this Git repository to /usr/src:
531 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
533 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
535 e70c17ce 2019-05-22 stsp .Dl $ got status
536 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
538 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
540 4e759de4 2019-06-26 stsp .Dl $ got branch -l
542 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
543 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
544 d83d9d5c 2019-05-13 stsp which is forked off the
548 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
550 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
551 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
552 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
554 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
556 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
557 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
559 fa6e0e48 2019-05-23 stsp .Dl $ got commit
561 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
562 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
563 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
565 fa6e0e48 2019-05-23 stsp .Dl $ got log -p -l 3 -b
567 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
569 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
570 fa6e0e48 2019-05-23 stsp .Dl $ got rm sys/uvm/uvm_vnode.c
572 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
573 e70c17ce 2019-05-22 stsp with a pre-defined log message.
575 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
577 e70c17ce 2019-05-22 stsp Update any work tree checked out from the
578 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
579 e70c17ce 2019-05-22 stsp branch to the latest commit on this branch:
581 fa6e0e48 2019-05-23 stsp .Dl $ got update
583 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
584 9221fb1e 2019-06-26 stsp This step currently requires
585 9221fb1e 2019-06-26 stsp .Xr git 1 :
587 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
588 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
591 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
592 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
595 fa6e0e48 2019-05-23 stsp This step currently requires
596 fa6e0e48 2019-05-23 stsp .Xr git 1 :
598 fa6e0e48 2019-05-23 stsp .Dl $ git clone /var/git/src.git ~/src-git-wt
599 fa6e0e48 2019-05-23 stsp .Dl $ cd ~/src-git-wt
600 fa6e0e48 2019-05-23 stsp .Dl $ git checkout unified-buffer-cache
601 fa6e0e48 2019-05-23 stsp .Dl $ git rebase master
602 fa6e0e48 2019-05-23 stsp .Dl $ git push -f
604 fa6e0e48 2019-05-23 stsp Update the work tree to the newly rebased
605 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
608 fa6e0e48 2019-05-23 stsp .Dl $ got update -b unified-buffer-cache
609 5c860e29 2018-03-12 stsp .Sh SEE ALSO
610 5e5560e1 2018-08-01 stsp .Xr git-repository 5
611 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
612 1a208aaf 2018-04-01 stsp .Sh AUTHORS
613 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
614 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
615 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
616 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
618 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
619 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
621 fa6e0e48 2019-05-23 stsp to perform many basic tasks.
623 fa6e0e48 2019-05-23 stsp When working against a repository created with
624 fa6e0e48 2019-05-23 stsp .Dq git clone --bare ,
625 fa6e0e48 2019-05-23 stsp local commits to the
627 fa6e0e48 2019-05-23 stsp branch are discouraged, for now, if changes committed to the upstream
628 fa6e0e48 2019-05-23 stsp repository need to be tracked.
629 fa6e0e48 2019-05-23 stsp See the EXAMPLES section.
