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 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
90 08573d5b 2019-05-14 stsp branch will be used.
91 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
92 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
93 38e11793 2018-06-13 stsp Only files beneath the specified
94 38e11793 2018-06-13 stsp .Ar path-prefix
95 38e11793 2018-06-13 stsp will be checked out.
97 024e9686 2019-05-14 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ]
98 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
99 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
100 7f838b36 2019-02-08 stsp .Bl -column YXZ description
101 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
102 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
103 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
104 7f838b36 2019-02-08 stsp .It D Ta file was deleted
105 7f838b36 2019-02-08 stsp .It A Ta new file was added
106 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
107 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
112 c4cdcb68 2019-04-03 stsp is specified, restrict the update operation to files at or within this path.
113 f2cf8fbb 2019-04-04 stsp The path is required to exist in the update operation's target commit.
114 f2cf8fbb 2019-04-04 stsp Files in the work tree outside this path will remain unchanged and will
115 f2cf8fbb 2019-04-04 stsp retain their previously recorded base commit.
118 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
119 c4cdcb68 2019-04-03 stsp multiple base commits.
120 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
121 47ec7be7 2019-05-12 stsp .Cm got update
122 47ec7be7 2019-05-12 stsp across the entire work tree.
123 024e9686 2019-05-14 stsp Specifying a
125 024e9686 2019-05-14 stsp is incompatible with the
129 507dc3bb 2018-12-29 stsp The options for
130 507dc3bb 2018-12-29 stsp .Cm got update
131 507dc3bb 2018-12-29 stsp are as follows:
132 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
133 024e9686 2019-05-14 stsp .It Fl b Ar branch
134 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
136 024e9686 2019-05-14 stsp before updating the work tree.
137 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
138 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
139 507dc3bb 2018-12-29 stsp Update the work tree to the specified
140 507dc3bb 2018-12-29 stsp .Ar commit .
141 0032ca71 2019-01-23 stsp The expected argument is a SHA1 hash which corresponds to a commit object.
142 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
143 024e9686 2019-05-14 stsp branch will be used.
145 927df6b7 2019-02-10 stsp .It Cm status [ Ar path ]
146 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
147 6bad629b 2019-02-04 stsp using the following status codes:
148 6bad629b 2019-02-04 stsp .Bl -column YXZ description
149 6bad629b 2019-02-04 stsp .It M Ta modified file
150 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
151 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
152 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
153 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
154 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
155 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
161 927df6b7 2019-02-10 stsp is specified, only show modifications within this path.
162 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 ]
163 38e11793 2018-06-13 stsp Display history of a repository.
166 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
168 38e11793 2018-06-13 stsp The options for
169 38e11793 2018-06-13 stsp .Cm got log
170 38e11793 2018-06-13 stsp are as follows:
171 38e11793 2018-06-13 stsp .Bl -tag -width Ds
173 43205691 2019-05-22 stsp Show the linear line of history of the current branch.
174 43205691 2019-05-22 stsp This option restricts history traversal to the first parent of each commit.
175 43205691 2019-05-22 stsp Commits which the branch was based on and merge commits which affected the
176 43205691 2019-05-22 stsp branch will be shown, but individual commits created on parallel branches
177 43205691 2019-05-22 stsp will be omitted.
178 38e11793 2018-06-13 stsp .It Fl c Ar commit
179 38e11793 2018-06-13 stsp Start traversing history at the specified
180 38e11793 2018-06-13 stsp .Ar commit .
181 d1f2edc9 2018-06-13 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
182 1cfab718 2018-06-13 stsp to a commit object.
183 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
184 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
185 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
186 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
188 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
189 6238ee32 2018-06-13 stsp .It Fl l Ar N
190 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
192 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
193 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
194 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
195 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
196 04ca23f4 2018-07-16 stsp working directory.
197 e9cf2e30 2019-02-05 stsp If this directory is a
199 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
201 927df6b7 2019-02-10 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
202 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
203 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
206 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
208 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
209 e02e74af 2019-05-28 stsp or a SHA1 hash, which corresponds to an object in the repository,
210 e02e74af 2019-05-28 stsp and display differences between these objects.
211 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
213 c0cc5c62 2018-10-18 stsp The options for
214 c0cc5c62 2018-10-18 stsp .Cm got diff
215 c0cc5c62 2018-10-18 stsp are as follows:
216 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
217 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
218 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
219 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
220 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
221 b72f483a 2019-02-05 stsp Use the repository at the specified path.
222 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
223 b72f483a 2019-02-05 stsp working directory.
224 b72f483a 2019-02-05 stsp If this directory is a
226 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
228 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
229 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
231 1ff8e573 2018-08-02 stsp The options for
232 1ff8e573 2018-08-02 stsp .Cm got blame
233 1ff8e573 2018-08-02 stsp are as follows:
234 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
235 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
236 1ff8e573 2018-08-02 stsp Start traversing history at the specified
237 1ff8e573 2018-08-02 stsp .Ar commit .
238 1ff8e573 2018-08-02 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
239 1ff8e573 2018-08-02 stsp to a commit object.
240 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
241 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
242 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
243 1ff8e573 2018-08-02 stsp working directory.
244 0c06baac 2019-02-05 stsp If this directory is a
246 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
248 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
249 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
250 5de5890b 2018-10-18 stsp directory path in the repository.
251 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
252 db0c2996 2019-02-10 stsp annotations:
253 db0c2996 2019-02-10 stsp .Bl -column YXZ description
254 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
255 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
260 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
261 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
262 0c849583 2019-02-05 stsp if there is no work tree.
264 5de5890b 2018-10-18 stsp The options for
265 5de5890b 2018-10-18 stsp .Cm got tree
266 5de5890b 2018-10-18 stsp are as follows:
267 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
268 5de5890b 2018-10-18 stsp .It Fl c Ar commit
269 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
270 5de5890b 2018-10-18 stsp .Ar commit .
271 5de5890b 2018-10-18 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
272 5de5890b 2018-10-18 stsp to a commit object.
273 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
274 5de5890b 2018-10-18 stsp Use the repository at the specified path.
275 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
276 5de5890b 2018-10-18 stsp working directory.
277 0c849583 2019-02-05 stsp If this directory is a
279 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
281 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
283 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
285 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
286 d0eebce4 2019-03-11 stsp Manage references in a repository.
288 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
289 d0eebce4 2019-03-11 stsp or update, the reference with the given
291 d0eebce4 2019-03-11 stsp and make it point at the given
292 d83d9d5c 2019-05-13 stsp .Ar target .
293 d83d9d5c 2019-05-13 stsp The target may be a SHA1 hash which corresponds to an existing object ID
294 d83d9d5c 2019-05-13 stsp in the repository, or an existing reference which will be resolved to an
297 d0eebce4 2019-03-11 stsp The options for
298 d0eebce4 2019-03-11 stsp .Cm got ref
299 d0eebce4 2019-03-11 stsp are as follows:
300 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
301 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
302 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
303 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
304 d0eebce4 2019-03-11 stsp working directory.
305 d0eebce4 2019-03-11 stsp If this directory is a
307 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
309 d0eebce4 2019-03-11 stsp List all existing references in the repository.
310 d0eebce4 2019-03-11 stsp .It Fl d Ar name
311 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
313 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
314 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
315 d00136be 2019-03-26 stsp repository in the next commit.
316 17ed4618 2019-06-02 stsp .It Cm rm Ar file-path ...
317 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
318 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
320 2ec1f75b 2019-03-26 stsp The options for
322 2ec1f75b 2019-03-26 stsp are as follows:
323 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
325 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
327 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
328 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
329 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
330 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
331 a129376b 2019-03-28 stsp changes back after
332 a129376b 2019-03-28 stsp .Cm got revert !
334 e20a8b6f 2019-06-04 stsp If a file was added with
335 a129376b 2019-03-28 stsp .Cm got add
336 a129376b 2019-03-28 stsp it will become an unversioned file again.
337 e20a8b6f 2019-06-04 stsp If a file was deleted with
339 a129376b 2019-03-28 stsp it will be restored.
340 74416c47 2019-05-09 stsp .It Cm commit [ Fl m Ar msg ] [ file-path ]
341 15cd91f7 2019-05-12 stsp Create a new commit in the repository from local changes in a work tree
342 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
344 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
345 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
346 15cd91f7 2019-05-12 stsp .It M Ta modified file
347 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
348 15cd91f7 2019-05-12 stsp .It A Ta new file was added
351 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
355 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
356 15cd91f7 2019-05-12 stsp multiple base commits.
357 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
358 47ec7be7 2019-05-12 stsp .Cm got update
359 47ec7be7 2019-05-12 stsp across the entire work tree.
362 15cd91f7 2019-05-12 stsp .Cm got commit
363 15cd91f7 2019-05-12 stsp command requires the
364 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
365 74416c47 2019-05-09 stsp environment variable to be set.
367 74416c47 2019-05-09 stsp The options for
368 74416c47 2019-05-09 stsp .Cm got commit
369 74416c47 2019-05-09 stsp are as follows:
370 74416c47 2019-05-09 stsp .Bl -tag -width Ds
371 74416c47 2019-05-09 stsp .It Fl m Ar msg
372 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
373 23594da9 2019-05-13 stsp Without the
376 23594da9 2019-05-13 stsp .Cm got commit
377 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
379 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
380 234035bc 2019-06-01 stsp Merge changes from a single
382 234035bc 2019-06-01 stsp into the work tree.
383 234035bc 2019-06-01 stsp The specified
385 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
386 234035bc 2019-06-01 stsp The expected argument is a reference or a SHA1 hash which corresponds to
387 234035bc 2019-06-01 stsp a commit object.
389 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
390 234035bc 2019-06-01 stsp .Bl -column YXZ description
391 234035bc 2019-06-01 stsp .It G Ta file was merged
392 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
393 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
394 234035bc 2019-06-01 stsp .It D Ta file was deleted
395 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
396 234035bc 2019-06-01 stsp .It A Ta new file was added
397 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
400 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
401 234035bc 2019-06-01 stsp may be viewed with
402 234035bc 2019-06-01 stsp .Cm got diff ,
403 234035bc 2019-06-01 stsp amended manually or with further
404 234035bc 2019-06-01 stsp .Cm got cherrypick
406 234035bc 2019-06-01 stsp committed with
407 234035bc 2019-06-01 stsp .Cm got commit ,
408 234035bc 2019-06-01 stsp or discarded again with
409 234035bc 2019-06-01 stsp .Cm got revert .
411 234035bc 2019-06-01 stsp .Cm got cherrypick
412 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
413 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
414 234035bc 2019-06-01 stsp to a single base commit with
415 234035bc 2019-06-01 stsp .Cm got update .
416 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
417 234035bc 2019-06-01 stsp conflicts must be resolved first.
418 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
419 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
421 5ef14e63 2019-06-02 stsp into the work tree.
422 5ef14e63 2019-06-02 stsp The specified
424 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
425 5ef14e63 2019-06-02 stsp The expected argument is a reference or a SHA1 hash which corresponds to
426 5ef14e63 2019-06-02 stsp a commit object.
428 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
429 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
430 5ef14e63 2019-06-02 stsp .It G Ta file was merged
431 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
432 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
433 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
434 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
435 5ef14e63 2019-06-02 stsp .It A Ta new file was added
436 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
439 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
440 5ef14e63 2019-06-02 stsp which may be viewed with
441 5ef14e63 2019-06-02 stsp .Cm got diff ,
442 5ef14e63 2019-06-02 stsp amended manually or with further
443 5ef14e63 2019-06-02 stsp .Cm got cherrypick
445 5ef14e63 2019-06-02 stsp committed with
446 5ef14e63 2019-06-02 stsp .Cm got commit ,
447 5ef14e63 2019-06-02 stsp or discarded again with
448 5ef14e63 2019-06-02 stsp .Cm got revert .
450 92228c38 2019-06-02 stsp .Cm got backout
451 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
452 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
453 92228c38 2019-06-02 stsp to a single base commit with
454 92228c38 2019-06-02 stsp .Cm got update .
455 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
456 92228c38 2019-06-02 stsp conflicts must be resolved first.
458 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
459 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
460 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
461 74416c47 2019-05-09 stsp The author's name and email address for
462 74416c47 2019-05-09 stsp .Cm got commit ,
463 74416c47 2019-05-09 stsp for example:
464 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
465 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
466 23594da9 2019-05-13 stsp The editor spawned by
467 23594da9 2019-05-13 stsp .Cm got commit .
469 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
470 5c860e29 2018-03-12 stsp .Ex -std got
471 97925469 2018-03-17 stsp .Sh EXAMPLES
473 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
475 fa6e0e48 2019-05-23 stsp This step currently requires
476 fa6e0e48 2019-05-23 stsp .Xr git 1 :
478 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
479 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
481 fa6e0e48 2019-05-23 stsp Check out a work tree from this Git repository to /usr/src:
483 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
485 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
487 e70c17ce 2019-05-22 stsp .Dl $ got status
488 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
490 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
492 e70c17ce 2019-05-22 stsp .Dl $ got ref -l | grep ^refs/heads
494 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
495 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
496 d83d9d5c 2019-05-13 stsp which is forked off the
500 e70c17ce 2019-05-22 stsp .Dl $ got ref refs/heads/unified-buffer-cache refs/heads/master
502 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
503 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
504 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
506 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
508 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
509 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
511 fa6e0e48 2019-05-23 stsp .Dl $ got commit
513 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
514 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
515 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
517 fa6e0e48 2019-05-23 stsp .Dl $ got log -p -l 3 -b
519 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
521 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
522 fa6e0e48 2019-05-23 stsp .Dl $ got rm sys/uvm/uvm_vnode.c
524 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
525 e70c17ce 2019-05-22 stsp with a pre-defined log message.
527 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
529 e70c17ce 2019-05-22 stsp Update any work tree checked out from the
530 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
531 e70c17ce 2019-05-22 stsp branch to the latest commit on this branch:
533 fa6e0e48 2019-05-23 stsp .Dl $ got update
535 fa6e0e48 2019-05-23 stsp Fetch new upstream commits into the local repository's master branch:
537 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
538 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
541 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
542 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
545 fa6e0e48 2019-05-23 stsp This step currently requires
546 fa6e0e48 2019-05-23 stsp .Xr git 1 :
548 fa6e0e48 2019-05-23 stsp .Dl $ git clone /var/git/src.git ~/src-git-wt
549 fa6e0e48 2019-05-23 stsp .Dl $ cd ~/src-git-wt
550 fa6e0e48 2019-05-23 stsp .Dl $ git checkout unified-buffer-cache
551 fa6e0e48 2019-05-23 stsp .Dl $ git rebase master
552 fa6e0e48 2019-05-23 stsp .Dl $ git push -f
554 fa6e0e48 2019-05-23 stsp Update the work tree to the newly rebased
555 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
558 fa6e0e48 2019-05-23 stsp .Dl $ got update -b unified-buffer-cache
559 5c860e29 2018-03-12 stsp .Sh SEE ALSO
560 5e5560e1 2018-08-01 stsp .Xr git-repository 5
561 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
562 1a208aaf 2018-04-01 stsp .Sh AUTHORS
563 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
564 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
565 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
566 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
568 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
569 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
571 fa6e0e48 2019-05-23 stsp to perform many basic tasks.
573 fa6e0e48 2019-05-23 stsp When working against a repository created with
574 fa6e0e48 2019-05-23 stsp .Dq git clone --bare ,
575 fa6e0e48 2019-05-23 stsp local commits to the
577 fa6e0e48 2019-05-23 stsp branch are discouraged, for now, if changes committed to the upstream
578 fa6e0e48 2019-05-23 stsp repository need to be tracked.
579 fa6e0e48 2019-05-23 stsp See the EXAMPLES section.
