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
68 3ce1b845 2019-07-15 stsp .Cm got init ,
70 3ce1b845 2019-07-15 stsp .Cm got import
71 3ce1b845 2019-07-15 stsp command must be used to populate the empty repository before
72 3ce1b845 2019-07-15 stsp .Cm got checkout
73 3ce1b845 2019-07-15 stsp can be used.
75 3ce1b845 2019-07-15 stsp .It Cm import [ Fl b Ar branch ] [ Fl m Ar message ] [ Fl r Ar repository-path ] [ Fl I Ar pattern ] directory
76 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
77 3ce1b845 2019-07-15 stsp within the specified
78 3ce1b845 2019-07-15 stsp .Ar directory .
79 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
80 3ce1b845 2019-07-15 stsp root commit.
81 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
82 3ce1b845 2019-07-15 stsp created commit.
84 3ce1b845 2019-07-15 stsp Show the path of each added file to indicate progress.
86 3ce1b845 2019-07-15 stsp The options for
87 3ce1b845 2019-07-15 stsp .Cm got import
88 3ce1b845 2019-07-15 stsp are as follows:
89 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
90 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
91 3ce1b845 2019-07-15 stsp Create the specified
93 3ce1b845 2019-07-15 stsp instead of creating the default branch
94 3ce1b845 2019-07-15 stsp .Dq master .
95 3ce1b845 2019-07-15 stsp Use of this option is required if the
97 3ce1b845 2019-07-15 stsp branch already exists.
98 3ce1b845 2019-07-15 stsp .It Fl m Ar message
99 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
100 3ce1b845 2019-07-15 stsp Without the
103 3ce1b845 2019-07-15 stsp .Cm got import
104 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
105 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
106 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
107 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
108 3ce1b845 2019-07-15 stsp working directory.
109 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
110 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
111 3ce1b845 2019-07-15 stsp .Ar pattern .
112 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
114 3ce1b845 2019-07-15 stsp .Ar pattern
115 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
116 3ce1b845 2019-07-15 stsp .Xr glob 7 .
118 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 ]
119 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
121 5d7c1dab 2018-04-01 stsp .Ar work tree path
122 c844a238 2019-02-06 stsp is not specified, either use the last component of
123 5d7c1dab 2018-04-01 stsp .Ar repository path ,
125 5d7c1dab 2018-04-01 stsp .Ar path prefix
126 c844a238 2019-02-06 stsp was specified use the last component of
127 5d7c1dab 2018-04-01 stsp .Ar path prefix .
129 38e11793 2018-06-13 stsp The options for
130 38e11793 2018-06-13 stsp .Cm got checkout
131 38e11793 2018-06-13 stsp are as follows:
132 38e11793 2018-06-13 stsp .Bl -tag -width Ds
133 08573d5b 2019-05-14 stsp .It Fl b Ar branch
134 08573d5b 2019-05-14 stsp Check out files from the specified
135 08573d5b 2019-05-14 stsp .Ar branch .
136 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
137 08573d5b 2019-05-14 stsp reference will be used.
138 8069f636 2019-01-12 stsp .It Fl c Ar commit
139 8069f636 2019-01-12 stsp Check out files from the specified
140 8069f636 2019-01-12 stsp .Ar commit .
141 0e1b0230 2019-07-07 stsp The expected argument is a commit ID SHA1 hash.
142 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
143 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
144 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
145 08573d5b 2019-05-14 stsp branch will be used.
146 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
147 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
148 38e11793 2018-06-13 stsp Only files beneath the specified
149 38e11793 2018-06-13 stsp .Ar path-prefix
150 38e11793 2018-06-13 stsp will be checked out.
153 97b3a7be 2019-07-09 stsp Short alias for
154 97b3a7be 2019-07-09 stsp .Cm checkout .
155 024e9686 2019-05-14 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ]
156 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
157 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
158 7f838b36 2019-02-08 stsp .Bl -column YXZ description
159 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
160 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
161 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
162 7f838b36 2019-02-08 stsp .It D Ta file was deleted
163 7f838b36 2019-02-08 stsp .It A Ta new file was added
164 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
165 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
170 c4cdcb68 2019-04-03 stsp is specified, restrict the update operation to files at or within this path.
171 f2cf8fbb 2019-04-04 stsp The path is required to exist in the update operation's target commit.
172 f2cf8fbb 2019-04-04 stsp Files in the work tree outside this path will remain unchanged and will
173 f2cf8fbb 2019-04-04 stsp retain their previously recorded base commit.
176 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
177 c4cdcb68 2019-04-03 stsp multiple base commits.
178 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
179 47ec7be7 2019-05-12 stsp .Cm got update
180 47ec7be7 2019-05-12 stsp across the entire work tree.
181 024e9686 2019-05-14 stsp Specifying a
183 024e9686 2019-05-14 stsp is incompatible with the
187 507dc3bb 2018-12-29 stsp The options for
188 507dc3bb 2018-12-29 stsp .Cm got update
189 507dc3bb 2018-12-29 stsp are as follows:
190 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
191 024e9686 2019-05-14 stsp .It Fl b Ar branch
192 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
194 024e9686 2019-05-14 stsp before updating the work tree.
195 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
196 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
197 507dc3bb 2018-12-29 stsp Update the work tree to the specified
198 507dc3bb 2018-12-29 stsp .Ar commit .
199 a54b6686 2019-06-28 stsp The expected argument is a commit ID SHA1 hash.
200 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
201 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
202 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
203 024e9686 2019-05-14 stsp branch will be used.
206 97b3a7be 2019-07-09 stsp Short alias for
207 97b3a7be 2019-07-09 stsp .Cm update .
208 927df6b7 2019-02-10 stsp .It Cm status [ Ar path ]
209 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
210 6bad629b 2019-02-04 stsp using the following status codes:
211 6bad629b 2019-02-04 stsp .Bl -column YXZ description
212 6bad629b 2019-02-04 stsp .It M Ta modified file
213 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
214 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
215 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
216 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
217 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
218 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
224 927df6b7 2019-02-10 stsp is specified, only show modifications within this path.
226 97b3a7be 2019-07-09 stsp Short alias for
227 97b3a7be 2019-07-09 stsp .Cm status .
228 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 ]
229 38e11793 2018-06-13 stsp Display history of a repository.
232 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
234 38e11793 2018-06-13 stsp The options for
235 38e11793 2018-06-13 stsp .Cm got log
236 38e11793 2018-06-13 stsp are as follows:
237 38e11793 2018-06-13 stsp .Bl -tag -width Ds
239 43205691 2019-05-22 stsp Show the linear line of history of the current branch.
240 43205691 2019-05-22 stsp This option restricts history traversal to the first parent of each commit.
241 43205691 2019-05-22 stsp Commits which the branch was based on and merge commits which affected the
242 43205691 2019-05-22 stsp branch will be shown, but individual commits created on parallel branches
243 43205691 2019-05-22 stsp will be omitted.
244 38e11793 2018-06-13 stsp .It Fl c Ar commit
245 38e11793 2018-06-13 stsp Start traversing history at the specified
246 38e11793 2018-06-13 stsp .Ar commit .
247 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
248 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
249 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
250 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
251 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
252 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
253 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
255 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
256 6238ee32 2018-06-13 stsp .It Fl l Ar N
257 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
259 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
260 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
261 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
262 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
263 04ca23f4 2018-07-16 stsp working directory.
264 e9cf2e30 2019-02-05 stsp If this directory is a
266 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
268 927df6b7 2019-02-10 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
269 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
270 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
273 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
275 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
276 a54b6686 2019-06-28 stsp or an object ID SHA1 hash, and display differences between these objects.
277 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
278 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
279 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
281 c0cc5c62 2018-10-18 stsp The options for
282 c0cc5c62 2018-10-18 stsp .Cm got diff
283 c0cc5c62 2018-10-18 stsp are as follows:
284 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
285 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
286 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
287 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
288 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
289 b72f483a 2019-02-05 stsp Use the repository at the specified path.
290 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
291 b72f483a 2019-02-05 stsp working directory.
292 b72f483a 2019-02-05 stsp If this directory is a
294 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
296 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
297 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
299 1ff8e573 2018-08-02 stsp The options for
300 1ff8e573 2018-08-02 stsp .Cm got blame
301 1ff8e573 2018-08-02 stsp are as follows:
302 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
303 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
304 1ff8e573 2018-08-02 stsp Start traversing history at the specified
305 1ff8e573 2018-08-02 stsp .Ar commit .
306 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
307 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
308 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
309 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
310 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
311 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
312 1ff8e573 2018-08-02 stsp working directory.
313 0c06baac 2019-02-05 stsp If this directory is a
315 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
317 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
318 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
319 5de5890b 2018-10-18 stsp directory path in the repository.
320 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
321 db0c2996 2019-02-10 stsp annotations:
322 db0c2996 2019-02-10 stsp .Bl -column YXZ description
323 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
324 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
329 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
330 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
331 0c849583 2019-02-05 stsp if there is no work tree.
333 5de5890b 2018-10-18 stsp The options for
334 5de5890b 2018-10-18 stsp .Cm got tree
335 5de5890b 2018-10-18 stsp are as follows:
336 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
337 5de5890b 2018-10-18 stsp .It Fl c Ar commit
338 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
339 5de5890b 2018-10-18 stsp .Ar commit .
340 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
341 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
342 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
343 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
344 5de5890b 2018-10-18 stsp Use the repository at the specified path.
345 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
346 5de5890b 2018-10-18 stsp working directory.
347 0c849583 2019-02-05 stsp If this directory is a
349 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
351 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
353 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
355 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
356 d0eebce4 2019-03-11 stsp Manage references in a repository.
358 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
359 d0eebce4 2019-03-11 stsp or update, the reference with the given
361 d0eebce4 2019-03-11 stsp and make it point at the given
362 d83d9d5c 2019-05-13 stsp .Ar target .
363 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
364 a54b6686 2019-06-28 stsp will be resolved to an object ID.
365 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
366 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
368 d0eebce4 2019-03-11 stsp The options for
369 d0eebce4 2019-03-11 stsp .Cm got ref
370 d0eebce4 2019-03-11 stsp are as follows:
371 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
372 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
373 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
374 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
375 d0eebce4 2019-03-11 stsp working directory.
376 d0eebce4 2019-03-11 stsp If this directory is a
378 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
380 d0eebce4 2019-03-11 stsp List all existing references in the repository.
381 d0eebce4 2019-03-11 stsp .It Fl d Ar name
382 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
384 4e759de4 2019-06-26 stsp .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
385 4e759de4 2019-06-26 stsp Manage branches in a repository.
387 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
388 4e759de4 2019-06-26 stsp .Dq refs/heads/
389 4e759de4 2019-06-26 stsp reference namespace.
391 4e759de4 2019-06-26 stsp .Cm got branch
392 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
394 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
395 4e759de4 2019-06-26 stsp a branch with the given
397 4e759de4 2019-06-26 stsp and make it point at the given
398 4e759de4 2019-06-26 stsp .Ar base-branch .
400 4e759de4 2019-06-26 stsp .Ar base-branch
401 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
402 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
404 4e759de4 2019-06-26 stsp The options for
405 4e759de4 2019-06-26 stsp .Cm got branch
406 4e759de4 2019-06-26 stsp are as follows:
407 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
408 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
409 4e759de4 2019-06-26 stsp Use the repository at the specified path.
410 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
411 4e759de4 2019-06-26 stsp working directory.
412 4e759de4 2019-06-26 stsp If this directory is a
414 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
416 4e759de4 2019-06-26 stsp List all existing branches in the repository.
418 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
419 ba882ee3 2019-07-11 stsp with one the following annotations:
420 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
421 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
422 ba882ee3 2019-07-11 stsp .It ~ Ta work tree's base commit is out-of-date
424 4e759de4 2019-06-26 stsp .It Fl d Ar name
425 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
426 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
427 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
428 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
429 ce33d90e 2019-07-14 stsp Git's garbage collector.
432 97b3a7be 2019-07-09 stsp Short alias for
433 97b3a7be 2019-07-09 stsp .Cm branch .
434 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
435 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
436 d00136be 2019-03-26 stsp repository in the next commit.
437 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
438 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
439 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
441 2ec1f75b 2019-03-26 stsp The options for
442 86d25a1b 2019-07-11 stsp .Cm got remove
443 2ec1f75b 2019-03-26 stsp are as follows:
444 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
446 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
449 648e4ef7 2019-07-09 stsp Short alias for
450 648e4ef7 2019-07-09 stsp .Cm remove .
451 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
452 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
453 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
454 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
455 a129376b 2019-03-28 stsp changes back after
456 a129376b 2019-03-28 stsp .Cm got revert !
458 e20a8b6f 2019-06-04 stsp If a file was added with
459 a129376b 2019-03-28 stsp .Cm got add
460 a129376b 2019-03-28 stsp it will become an unversioned file again.
461 e20a8b6f 2019-06-04 stsp If a file was deleted with
462 86d25a1b 2019-07-11 stsp .Cm got remove
463 a129376b 2019-03-28 stsp it will be restored.
465 97b3a7be 2019-07-09 stsp Short alias for
466 97b3a7be 2019-07-09 stsp .Cm revert .
467 74ff3f23 2019-07-07 stsp .It Cm commit [ Fl m Ar message ] [ file-path ]
468 15cd91f7 2019-05-12 stsp Create a new commit in the repository from local changes in a work tree
469 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
471 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
472 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
473 15cd91f7 2019-05-12 stsp .It M Ta modified file
474 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
475 15cd91f7 2019-05-12 stsp .It A Ta new file was added
478 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
482 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
483 15cd91f7 2019-05-12 stsp multiple base commits.
484 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
485 47ec7be7 2019-05-12 stsp .Cm got update
486 47ec7be7 2019-05-12 stsp across the entire work tree.
489 15cd91f7 2019-05-12 stsp .Cm got commit
490 15cd91f7 2019-05-12 stsp command requires the
491 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
492 74416c47 2019-05-09 stsp environment variable to be set.
494 74416c47 2019-05-09 stsp The options for
495 74416c47 2019-05-09 stsp .Cm got commit
496 74416c47 2019-05-09 stsp are as follows:
497 74416c47 2019-05-09 stsp .Bl -tag -width Ds
498 74ff3f23 2019-07-07 stsp .It Fl m Ar message
499 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
500 23594da9 2019-05-13 stsp Without the
503 23594da9 2019-05-13 stsp .Cm got commit
504 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
507 97b3a7be 2019-07-09 stsp Short alias for
508 97b3a7be 2019-07-09 stsp .Cm commit .
509 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
510 234035bc 2019-06-01 stsp Merge changes from a single
512 234035bc 2019-06-01 stsp into the work tree.
513 234035bc 2019-06-01 stsp The specified
515 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
516 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
517 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
518 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
520 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
521 234035bc 2019-06-01 stsp .Bl -column YXZ description
522 234035bc 2019-06-01 stsp .It G Ta file was merged
523 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
524 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
525 234035bc 2019-06-01 stsp .It D Ta file was deleted
526 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
527 234035bc 2019-06-01 stsp .It A Ta new file was added
528 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
531 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
532 234035bc 2019-06-01 stsp may be viewed with
533 234035bc 2019-06-01 stsp .Cm got diff ,
534 234035bc 2019-06-01 stsp amended manually or with further
535 234035bc 2019-06-01 stsp .Cm got cherrypick
537 234035bc 2019-06-01 stsp committed with
538 234035bc 2019-06-01 stsp .Cm got commit ,
539 234035bc 2019-06-01 stsp or discarded again with
540 234035bc 2019-06-01 stsp .Cm got revert .
542 234035bc 2019-06-01 stsp .Cm got cherrypick
543 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
544 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
545 234035bc 2019-06-01 stsp to a single base commit with
546 234035bc 2019-06-01 stsp .Cm got update .
547 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
548 234035bc 2019-06-01 stsp conflicts must be resolved first.
550 97b3a7be 2019-07-09 stsp Short alias for
551 97b3a7be 2019-07-09 stsp .Cm cherrypick .
552 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
553 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
555 5ef14e63 2019-06-02 stsp into the work tree.
556 5ef14e63 2019-06-02 stsp The specified
558 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
559 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
560 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
561 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
563 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
564 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
565 5ef14e63 2019-06-02 stsp .It G Ta file was merged
566 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
567 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
568 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
569 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
570 5ef14e63 2019-06-02 stsp .It A Ta new file was added
571 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
574 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
575 5ef14e63 2019-06-02 stsp which may be viewed with
576 5ef14e63 2019-06-02 stsp .Cm got diff ,
577 5ef14e63 2019-06-02 stsp amended manually or with further
578 778a73c2 2019-07-12 stsp .Cm got backout
580 5ef14e63 2019-06-02 stsp committed with
581 5ef14e63 2019-06-02 stsp .Cm got commit ,
582 5ef14e63 2019-06-02 stsp or discarded again with
583 5ef14e63 2019-06-02 stsp .Cm got revert .
585 92228c38 2019-06-02 stsp .Cm got backout
586 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
587 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
588 92228c38 2019-06-02 stsp to a single base commit with
589 92228c38 2019-06-02 stsp .Cm got update .
590 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
591 92228c38 2019-06-02 stsp conflicts must be resolved first.
593 97b3a7be 2019-07-09 stsp Short alias for
594 97b3a7be 2019-07-09 stsp .Cm backout .
595 cd98404f 2019-07-14 stsp .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
596 818c7501 2019-07-11 stsp Rebase commits on the specified
598 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
601 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
602 f09e2405 2019-07-11 stsp Rebasing begins with the first descendent commit of the youngest
603 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
605 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
606 f09e2405 2019-07-11 stsp of the specified
608 f09e2405 2019-07-11 stsp has been rebased.
610 818c7501 2019-07-11 stsp Rebased commits are accumulated on a temporary branch and represent
611 f09e2405 2019-07-11 stsp the same changes with the same log messages as their counterparts
612 f09e2405 2019-07-11 stsp on the original
613 818c7501 2019-07-11 stsp .Ar branch ,
614 818c7501 2019-07-11 stsp but with different commit IDs.
615 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
616 f09e2405 2019-07-11 stsp the new version of the specified
618 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
620 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
621 818c7501 2019-07-11 stsp using the following status codes:
622 818c7501 2019-07-11 stsp .Bl -column YXZ description
623 818c7501 2019-07-11 stsp .It G Ta file was merged
624 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
625 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
626 818c7501 2019-07-11 stsp .It D Ta file was deleted
627 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
628 818c7501 2019-07-11 stsp .It A Ta new file was added
629 818c7501 2019-07-11 stsp .It ~ Ta changes destined for a non-regular file were not merged
632 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
633 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
634 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
636 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
638 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
639 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
640 f09e2405 2019-07-11 stsp when the rebase operation continues.
642 818c7501 2019-07-11 stsp .Cm got rebase
643 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
644 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
645 818c7501 2019-07-11 stsp to a single base commit with
646 818c7501 2019-07-11 stsp .Cm got update .
647 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
648 f09e2405 2019-07-11 stsp committed with
649 f09e2405 2019-07-11 stsp .Cm got commit
650 f09e2405 2019-07-11 stsp or reverted with
651 f09e2405 2019-07-11 stsp .Cm got revert .
654 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
655 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
658 7d5807f4 2019-07-11 stsp .Cm got update
660 7d5807f4 2019-07-11 stsp .Cm got commit
661 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
662 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
663 7d5807f4 2019-07-11 stsp conflict resolution purposes.
665 818c7501 2019-07-11 stsp The options for
666 818c7501 2019-07-11 stsp .Cm got rebase
667 818c7501 2019-07-11 stsp are as follows:
668 818c7501 2019-07-11 stsp .Bl -tag -width Ds
670 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
671 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
673 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
674 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
677 818c7501 2019-07-11 stsp Short alias for
678 818c7501 2019-07-11 stsp .Cm rebase .
680 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
681 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
682 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
683 74416c47 2019-05-09 stsp The author's name and email address for
684 74416c47 2019-05-09 stsp .Cm got commit ,
685 74416c47 2019-05-09 stsp for example:
686 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
687 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
688 23594da9 2019-05-13 stsp The editor spawned by
689 23594da9 2019-05-13 stsp .Cm got commit .
691 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
692 5c860e29 2018-03-12 stsp .Ex -std got
693 97925469 2018-03-17 stsp .Sh EXAMPLES
694 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
696 fa6e0e48 2019-05-23 stsp This step currently requires
697 fa6e0e48 2019-05-23 stsp .Xr git 1 :
699 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
700 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
702 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
704 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
705 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
706 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
708 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
709 3ce1b845 2019-07-15 stsp .Dl $ got import -r /var/src.git -I CVS -I obj /tmp/src
711 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
713 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
715 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
717 e70c17ce 2019-05-22 stsp .Dl $ got status
718 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
720 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
722 4e759de4 2019-06-26 stsp .Dl $ got branch -l
724 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
725 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
726 d83d9d5c 2019-05-13 stsp which is forked off the
730 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
732 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
733 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
734 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
736 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
738 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
739 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
741 fa6e0e48 2019-05-23 stsp .Dl $ got commit
743 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
744 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
745 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
747 fa6e0e48 2019-05-23 stsp .Dl $ got log -p -l 3 -b
749 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
751 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
752 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
754 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
755 e70c17ce 2019-05-22 stsp with a pre-defined log message.
757 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
759 e70c17ce 2019-05-22 stsp Update any work tree checked out from the
760 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
761 e70c17ce 2019-05-22 stsp branch to the latest commit on this branch:
763 fa6e0e48 2019-05-23 stsp .Dl $ got update
765 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
766 9221fb1e 2019-06-26 stsp This step currently requires
767 9221fb1e 2019-06-26 stsp .Xr git 1 :
769 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
770 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
773 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
774 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
778 818c7501 2019-07-11 stsp .Dl $ got update -b master
779 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
781 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
782 7d7ffedb 2019-07-14 stsp The patch can be mailed out for review and applied to OpenBSD's CVS tree:
784 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
786 5c860e29 2018-03-12 stsp .Sh SEE ALSO
787 5e5560e1 2018-08-01 stsp .Xr git-repository 5
788 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
789 1a208aaf 2018-04-01 stsp .Sh AUTHORS
790 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
791 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
792 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
793 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
795 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
796 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
798 b48be8cf 2019-07-14 stsp to perform tasks related to repository administration and tasks
799 b48be8cf 2019-07-14 stsp which require a network connection.
801 fa6e0e48 2019-05-23 stsp When working against a repository created with
802 fa6e0e48 2019-05-23 stsp .Dq git clone --bare ,
803 fa6e0e48 2019-05-23 stsp local commits to the
805 fa6e0e48 2019-05-23 stsp branch are discouraged, for now, if changes committed to the upstream
806 fa6e0e48 2019-05-23 stsp repository need to be tracked.
807 fa6e0e48 2019-05-23 stsp See the EXAMPLES section.
808 723bd6d4 2019-07-14 stsp Future built-in
812 723bd6d4 2019-07-14 stsp commands should alleviate this problem.
