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 09ea71ba 2019-07-27 stsp .It Cm init Ar repository-path
64 2c7829a4 2019-06-17 stsp Create a new empty repository at the specified
65 09ea71ba 2019-07-27 stsp .Ar repository-path .
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.
83 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
86 21a44f98 2019-07-15 stsp .Cm got import
87 21a44f98 2019-07-15 stsp command requires the
88 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
89 21a44f98 2019-07-15 stsp environment variable to be set.
91 3ce1b845 2019-07-15 stsp The options for
92 3ce1b845 2019-07-15 stsp .Cm got import
93 3ce1b845 2019-07-15 stsp are as follows:
94 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
95 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
96 3ce1b845 2019-07-15 stsp Create the specified
98 3ce1b845 2019-07-15 stsp instead of creating the default branch
99 3ce1b845 2019-07-15 stsp .Dq master .
100 3ce1b845 2019-07-15 stsp Use of this option is required if the
102 3ce1b845 2019-07-15 stsp branch already exists.
103 3ce1b845 2019-07-15 stsp .It Fl m Ar message
104 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
105 3ce1b845 2019-07-15 stsp Without the
108 3ce1b845 2019-07-15 stsp .Cm got import
109 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
110 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
111 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
112 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
113 3ce1b845 2019-07-15 stsp working directory.
114 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
115 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
116 3ce1b845 2019-07-15 stsp .Ar pattern .
117 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
119 3ce1b845 2019-07-15 stsp .Ar pattern
120 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
121 3ce1b845 2019-07-15 stsp .Xr glob 7 .
123 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 ]
124 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
126 5d7c1dab 2018-04-01 stsp .Ar work tree path
127 c844a238 2019-02-06 stsp is not specified, either use the last component of
128 5d7c1dab 2018-04-01 stsp .Ar repository path ,
130 5d7c1dab 2018-04-01 stsp .Ar path prefix
131 c844a238 2019-02-06 stsp was specified use the last component of
132 5d7c1dab 2018-04-01 stsp .Ar path prefix .
134 38e11793 2018-06-13 stsp The options for
135 38e11793 2018-06-13 stsp .Cm got checkout
136 38e11793 2018-06-13 stsp are as follows:
137 38e11793 2018-06-13 stsp .Bl -tag -width Ds
138 08573d5b 2019-05-14 stsp .It Fl b Ar branch
139 3c575567 2019-07-28 stsp Check out files from a commit on the specified
140 08573d5b 2019-05-14 stsp .Ar branch .
141 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
142 08573d5b 2019-05-14 stsp reference will be used.
143 8069f636 2019-01-12 stsp .It Fl c Ar commit
144 8069f636 2019-01-12 stsp Check out files from the specified
146 3c575567 2019-07-28 stsp on the selected branch.
147 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
148 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
149 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
150 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
151 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
152 08573d5b 2019-05-14 stsp branch will be used.
153 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
154 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
155 38e11793 2018-06-13 stsp Only files beneath the specified
156 38e11793 2018-06-13 stsp .Ar path-prefix
157 38e11793 2018-06-13 stsp will be checked out.
160 97b3a7be 2019-07-09 stsp Short alias for
161 97b3a7be 2019-07-09 stsp .Cm checkout .
162 f2ea84fa 2019-07-27 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ... ]
163 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
164 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
165 7f838b36 2019-02-08 stsp .Bl -column YXZ description
166 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
167 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
168 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
169 7f838b36 2019-02-08 stsp .It D Ta file was deleted
170 7f838b36 2019-02-08 stsp .It A Ta new file was added
171 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
172 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
177 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
178 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
179 f2ea84fa 2019-07-27 stsp specified paths.
180 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
181 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
182 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
185 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
186 c4cdcb68 2019-04-03 stsp multiple base commits.
187 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
188 47ec7be7 2019-05-12 stsp .Cm got update
189 47ec7be7 2019-05-12 stsp across the entire work tree.
190 024e9686 2019-05-14 stsp Specifying a
192 024e9686 2019-05-14 stsp is incompatible with the
196 507dc3bb 2018-12-29 stsp The options for
197 507dc3bb 2018-12-29 stsp .Cm got update
198 507dc3bb 2018-12-29 stsp are as follows:
199 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
200 024e9686 2019-05-14 stsp .It Fl b Ar branch
201 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
203 024e9686 2019-05-14 stsp before updating the work tree.
204 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
205 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
206 507dc3bb 2018-12-29 stsp Update the work tree to the specified
207 507dc3bb 2018-12-29 stsp .Ar commit .
208 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
209 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
210 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
211 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
212 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
213 024e9686 2019-05-14 stsp branch will be used.
216 97b3a7be 2019-07-09 stsp Short alias for
217 97b3a7be 2019-07-09 stsp .Cm update .
218 72ea6654 2019-07-27 stsp .It Cm status [ Ar path ... ]
219 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
220 6bad629b 2019-02-04 stsp using the following status codes:
221 6bad629b 2019-02-04 stsp .Bl -column YXZ description
222 6bad629b 2019-02-04 stsp .It M Ta modified file
223 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
224 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
225 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
226 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
227 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
228 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
234 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
235 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
237 97b3a7be 2019-07-09 stsp Short alias for
238 97b3a7be 2019-07-09 stsp .Cm status .
239 f400486b 2019-07-15 stsp .It Cm log [ Fl c Ar commit ] [ Fl C Ar number ] [ Fl f ] [ Fl l Ar N ] [ Fl p ] [ Fl r Ar repository-path ] [ path ]
240 38e11793 2018-06-13 stsp Display history of a repository.
243 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
245 38e11793 2018-06-13 stsp The options for
246 38e11793 2018-06-13 stsp .Cm got log
247 38e11793 2018-06-13 stsp are as follows:
248 38e11793 2018-06-13 stsp .Bl -tag -width Ds
249 38e11793 2018-06-13 stsp .It Fl c Ar commit
250 38e11793 2018-06-13 stsp Start traversing history at the specified
251 38e11793 2018-06-13 stsp .Ar commit .
252 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
253 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
254 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
255 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
256 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
257 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
258 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
259 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
261 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
263 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
264 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
265 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
266 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
267 6238ee32 2018-06-13 stsp .It Fl l Ar N
268 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
270 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
271 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
272 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
273 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
274 04ca23f4 2018-07-16 stsp working directory.
275 e9cf2e30 2019-02-05 stsp If this directory is a
277 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
279 927df6b7 2019-02-10 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
280 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
281 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
284 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
286 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
287 a54b6686 2019-06-28 stsp or an object ID SHA1 hash, and display differences between these objects.
288 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
289 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
290 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
292 c0cc5c62 2018-10-18 stsp The options for
293 c0cc5c62 2018-10-18 stsp .Cm got diff
294 c0cc5c62 2018-10-18 stsp are as follows:
295 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
296 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
297 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
298 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
299 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
300 b72f483a 2019-02-05 stsp Use the repository at the specified path.
301 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
302 b72f483a 2019-02-05 stsp working directory.
303 b72f483a 2019-02-05 stsp If this directory is a
305 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
307 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
308 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
310 1ff8e573 2018-08-02 stsp The options for
311 1ff8e573 2018-08-02 stsp .Cm got blame
312 1ff8e573 2018-08-02 stsp are as follows:
313 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
314 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
315 1ff8e573 2018-08-02 stsp Start traversing history at the specified
316 1ff8e573 2018-08-02 stsp .Ar commit .
317 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
318 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
319 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
320 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
321 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
322 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
323 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
324 1ff8e573 2018-08-02 stsp working directory.
325 0c06baac 2019-02-05 stsp If this directory is a
327 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
329 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
330 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
331 5de5890b 2018-10-18 stsp directory path in the repository.
332 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
333 db0c2996 2019-02-10 stsp annotations:
334 db0c2996 2019-02-10 stsp .Bl -column YXZ description
335 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
336 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
341 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
342 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
343 0c849583 2019-02-05 stsp if there is no work tree.
345 5de5890b 2018-10-18 stsp The options for
346 5de5890b 2018-10-18 stsp .Cm got tree
347 5de5890b 2018-10-18 stsp are as follows:
348 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
349 5de5890b 2018-10-18 stsp .It Fl c Ar commit
350 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
351 5de5890b 2018-10-18 stsp .Ar commit .
352 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
353 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
354 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
355 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
356 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
357 5de5890b 2018-10-18 stsp Use the repository at the specified path.
358 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
359 5de5890b 2018-10-18 stsp working directory.
360 0c849583 2019-02-05 stsp If this directory is a
362 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
364 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
366 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
368 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
369 d0eebce4 2019-03-11 stsp Manage references in a repository.
371 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
372 d0eebce4 2019-03-11 stsp or update, the reference with the given
374 d0eebce4 2019-03-11 stsp and make it point at the given
375 d83d9d5c 2019-05-13 stsp .Ar target .
376 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
377 a54b6686 2019-06-28 stsp will be resolved to an object ID.
378 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
379 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
381 d0eebce4 2019-03-11 stsp The options for
382 d0eebce4 2019-03-11 stsp .Cm got ref
383 d0eebce4 2019-03-11 stsp are as follows:
384 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
385 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
386 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
387 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
388 d0eebce4 2019-03-11 stsp working directory.
389 d0eebce4 2019-03-11 stsp If this directory is a
391 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
393 d0eebce4 2019-03-11 stsp List all existing references in the repository.
394 d0eebce4 2019-03-11 stsp .It Fl d Ar name
395 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
397 4e759de4 2019-06-26 stsp .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
398 4e759de4 2019-06-26 stsp Manage branches in a repository.
400 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
401 4e759de4 2019-06-26 stsp .Dq refs/heads/
402 4e759de4 2019-06-26 stsp reference namespace.
404 4e759de4 2019-06-26 stsp .Cm got branch
405 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
407 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
408 4e759de4 2019-06-26 stsp a branch with the given
410 4e759de4 2019-06-26 stsp and make it point at the given
411 4e759de4 2019-06-26 stsp .Ar base-branch .
413 4e759de4 2019-06-26 stsp .Ar base-branch
414 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
415 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
417 4e759de4 2019-06-26 stsp The options for
418 4e759de4 2019-06-26 stsp .Cm got branch
419 4e759de4 2019-06-26 stsp are as follows:
420 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
421 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
422 4e759de4 2019-06-26 stsp Use the repository at the specified path.
423 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
424 4e759de4 2019-06-26 stsp working directory.
425 4e759de4 2019-06-26 stsp If this directory is a
427 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
429 4e759de4 2019-06-26 stsp List all existing branches in the repository.
430 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
431 ba882ee3 2019-07-11 stsp with one the following annotations:
432 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
433 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
434 ba882ee3 2019-07-11 stsp .It ~ Ta work tree's base commit is out-of-date
436 4e759de4 2019-06-26 stsp .It Fl d Ar name
437 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
438 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
439 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
440 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
441 ce33d90e 2019-07-14 stsp Git's garbage collector.
444 97b3a7be 2019-07-09 stsp Short alias for
445 97b3a7be 2019-07-09 stsp .Cm branch .
446 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
447 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
448 d00136be 2019-03-26 stsp repository in the next commit.
449 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
450 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
451 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
453 2ec1f75b 2019-03-26 stsp The options for
454 86d25a1b 2019-07-11 stsp .Cm got remove
455 2ec1f75b 2019-03-26 stsp are as follows:
456 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
458 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
461 648e4ef7 2019-07-09 stsp Short alias for
462 648e4ef7 2019-07-09 stsp .Cm remove .
463 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
464 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
465 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
466 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
467 a129376b 2019-03-28 stsp changes back after
468 a129376b 2019-03-28 stsp .Cm got revert !
470 e20a8b6f 2019-06-04 stsp If a file was added with
471 a129376b 2019-03-28 stsp .Cm got add
472 a129376b 2019-03-28 stsp it will become an unversioned file again.
473 e20a8b6f 2019-06-04 stsp If a file was deleted with
474 86d25a1b 2019-07-11 stsp .Cm got remove
475 a129376b 2019-03-28 stsp it will be restored.
477 97b3a7be 2019-07-09 stsp Short alias for
478 97b3a7be 2019-07-09 stsp .Cm revert .
479 5c1e53bc 2019-07-28 stsp .It Cm commit [ Fl m Ar message ] [ path ... ]
480 15cd91f7 2019-05-12 stsp Create a new commit in the repository from local changes in a work tree
481 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
484 5c1e53bc 2019-07-28 stsp is specified, commit all local changes in the work tree.
485 5c1e53bc 2019-07-28 stsp Otherwise, commit local changes at or within the specified paths.
487 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
488 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
489 15cd91f7 2019-05-12 stsp .It M Ta modified file
490 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
491 15cd91f7 2019-05-12 stsp .It A Ta new file was added
494 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
498 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
499 15cd91f7 2019-05-12 stsp multiple base commits.
500 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
501 47ec7be7 2019-05-12 stsp .Cm got update
502 47ec7be7 2019-05-12 stsp across the entire work tree.
505 15cd91f7 2019-05-12 stsp .Cm got commit
506 15cd91f7 2019-05-12 stsp command requires the
507 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
508 74416c47 2019-05-09 stsp environment variable to be set.
510 74416c47 2019-05-09 stsp The options for
511 74416c47 2019-05-09 stsp .Cm got commit
512 74416c47 2019-05-09 stsp are as follows:
513 74416c47 2019-05-09 stsp .Bl -tag -width Ds
514 74ff3f23 2019-07-07 stsp .It Fl m Ar message
515 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
516 23594da9 2019-05-13 stsp Without the
519 23594da9 2019-05-13 stsp .Cm got commit
520 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
523 cfce0458 2019-07-28 stsp .Cm got commit
524 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
525 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
526 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
527 cfce0458 2019-07-28 stsp If a path is found to be out of date,
528 cfce0458 2019-07-28 stsp .Cm got update
529 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
530 cfce0458 2019-07-28 stsp in the repository.
532 97b3a7be 2019-07-09 stsp Short alias for
533 97b3a7be 2019-07-09 stsp .Cm commit .
534 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
535 234035bc 2019-06-01 stsp Merge changes from a single
537 234035bc 2019-06-01 stsp into the work tree.
538 234035bc 2019-06-01 stsp The specified
540 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
541 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
542 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
543 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
545 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
546 234035bc 2019-06-01 stsp .Bl -column YXZ description
547 234035bc 2019-06-01 stsp .It G Ta file was merged
548 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
549 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
550 234035bc 2019-06-01 stsp .It D Ta file was deleted
551 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
552 234035bc 2019-06-01 stsp .It A Ta new file was added
553 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
556 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
557 234035bc 2019-06-01 stsp may be viewed with
558 234035bc 2019-06-01 stsp .Cm got diff ,
559 234035bc 2019-06-01 stsp amended manually or with further
560 234035bc 2019-06-01 stsp .Cm got cherrypick
562 234035bc 2019-06-01 stsp committed with
563 234035bc 2019-06-01 stsp .Cm got commit ,
564 234035bc 2019-06-01 stsp or discarded again with
565 234035bc 2019-06-01 stsp .Cm got revert .
567 234035bc 2019-06-01 stsp .Cm got cherrypick
568 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
569 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
570 234035bc 2019-06-01 stsp to a single base commit with
571 234035bc 2019-06-01 stsp .Cm got update .
572 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
573 234035bc 2019-06-01 stsp conflicts must be resolved first.
575 97b3a7be 2019-07-09 stsp Short alias for
576 97b3a7be 2019-07-09 stsp .Cm cherrypick .
577 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
578 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
580 5ef14e63 2019-06-02 stsp into the work tree.
581 5ef14e63 2019-06-02 stsp The specified
583 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
584 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
585 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
586 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
588 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
589 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
590 5ef14e63 2019-06-02 stsp .It G Ta file was merged
591 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
592 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
593 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
594 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
595 5ef14e63 2019-06-02 stsp .It A Ta new file was added
596 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
599 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
600 5ef14e63 2019-06-02 stsp which may be viewed with
601 5ef14e63 2019-06-02 stsp .Cm got diff ,
602 5ef14e63 2019-06-02 stsp amended manually or with further
603 778a73c2 2019-07-12 stsp .Cm got backout
605 5ef14e63 2019-06-02 stsp committed with
606 5ef14e63 2019-06-02 stsp .Cm got commit ,
607 5ef14e63 2019-06-02 stsp or discarded again with
608 5ef14e63 2019-06-02 stsp .Cm got revert .
610 92228c38 2019-06-02 stsp .Cm got backout
611 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
612 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
613 92228c38 2019-06-02 stsp to a single base commit with
614 92228c38 2019-06-02 stsp .Cm got update .
615 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
616 92228c38 2019-06-02 stsp conflicts must be resolved first.
618 97b3a7be 2019-07-09 stsp Short alias for
619 97b3a7be 2019-07-09 stsp .Cm backout .
620 cd98404f 2019-07-14 stsp .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
621 818c7501 2019-07-11 stsp Rebase commits on the specified
623 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
626 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
627 f09e2405 2019-07-11 stsp Rebasing begins with the first descendent commit of the youngest
628 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
630 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
631 f09e2405 2019-07-11 stsp of the specified
633 f09e2405 2019-07-11 stsp has been rebased.
635 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
636 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
637 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
638 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
639 818c7501 2019-07-11 stsp .Ar branch ,
640 818c7501 2019-07-11 stsp but with different commit IDs.
641 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
642 f09e2405 2019-07-11 stsp the new version of the specified
644 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
646 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
647 818c7501 2019-07-11 stsp using the following status codes:
648 818c7501 2019-07-11 stsp .Bl -column YXZ description
649 818c7501 2019-07-11 stsp .It G Ta file was merged
650 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
651 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
652 818c7501 2019-07-11 stsp .It D Ta file was deleted
653 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
654 818c7501 2019-07-11 stsp .It A Ta new file was added
655 818c7501 2019-07-11 stsp .It ~ Ta changes destined for a non-regular file were not merged
658 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
659 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
660 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
662 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
664 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
665 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
666 f09e2405 2019-07-11 stsp when the rebase operation continues.
668 818c7501 2019-07-11 stsp .Cm got rebase
669 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
670 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
671 818c7501 2019-07-11 stsp to a single base commit with
672 818c7501 2019-07-11 stsp .Cm got update .
673 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
674 f09e2405 2019-07-11 stsp committed with
675 f09e2405 2019-07-11 stsp .Cm got commit
676 f09e2405 2019-07-11 stsp or reverted with
677 f09e2405 2019-07-11 stsp .Cm got revert .
680 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
681 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
684 7d5807f4 2019-07-11 stsp .Cm got update
686 7d5807f4 2019-07-11 stsp .Cm got commit
687 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
688 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
689 7d5807f4 2019-07-11 stsp conflict resolution purposes.
691 818c7501 2019-07-11 stsp The options for
692 818c7501 2019-07-11 stsp .Cm got rebase
693 818c7501 2019-07-11 stsp are as follows:
694 818c7501 2019-07-11 stsp .Bl -tag -width Ds
696 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
697 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
699 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
700 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
703 818c7501 2019-07-11 stsp Short alias for
704 818c7501 2019-07-11 stsp .Cm rebase .
705 0ebf8283 2019-07-24 stsp .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
706 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
707 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
709 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
710 0ebf8283 2019-07-24 stsp .Ar histedit script
711 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
712 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
713 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
714 0ebf8283 2019-07-24 stsp whitespace and an argument.
715 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
716 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
717 0ebf8283 2019-07-24 stsp Lines which begin with the
719 0ebf8283 2019-07-24 stsp character are ignored entirely.
721 0ebf8283 2019-07-24 stsp The available commands are as follows:
722 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
723 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
724 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
725 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
726 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
727 0ebf8283 2019-07-24 stsp listed further below that will be used.
728 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
729 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
730 0ebf8283 2019-07-24 stsp the commit on the previous line.
731 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
732 0ebf8283 2019-07-24 stsp log message can be written.
735 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
736 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
738 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
739 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
740 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
741 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
742 498a90b7 2019-07-25 stsp switched to it.
744 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
745 0ebf8283 2019-07-24 stsp using the following status codes:
746 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
747 0ebf8283 2019-07-24 stsp .It G Ta file was merged
748 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
749 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
750 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
751 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
752 0ebf8283 2019-07-24 stsp .It A Ta new file was added
753 0ebf8283 2019-07-24 stsp .It ~ Ta changes destined for a non-regular file were not merged
756 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
757 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
758 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
759 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
761 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
762 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
763 0ebf8283 2019-07-24 stsp when the histedit operation continues.
765 0ebf8283 2019-07-24 stsp .Cm got histedit
766 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
767 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
768 0ebf8283 2019-07-24 stsp to a single base commit with
769 0ebf8283 2019-07-24 stsp .Cm got update .
770 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
771 0ebf8283 2019-07-24 stsp committed with
772 0ebf8283 2019-07-24 stsp .Cm got commit
773 0ebf8283 2019-07-24 stsp or reverted with
774 0ebf8283 2019-07-24 stsp .Cm got revert .
775 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
776 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
779 0ebf8283 2019-07-24 stsp .Cm got update
780 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
781 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
782 0ebf8283 2019-07-24 stsp .Cm got commit
783 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
784 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
786 0ebf8283 2019-07-24 stsp The options for
787 0ebf8283 2019-07-24 stsp .Cm got histedit
788 0ebf8283 2019-07-24 stsp are as follows:
789 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
791 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
792 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
794 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
795 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
798 0ebf8283 2019-07-24 stsp Short alias for
799 0ebf8283 2019-07-24 stsp .Cm histedit .
801 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
802 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
803 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
804 74416c47 2019-05-09 stsp The author's name and email address for
805 21a44f98 2019-07-15 stsp .Cm got commit
807 21a44f98 2019-07-15 stsp .Cm got import ,
808 74416c47 2019-05-09 stsp for example:
809 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
810 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
811 23594da9 2019-05-13 stsp The editor spawned by
812 23594da9 2019-05-13 stsp .Cm got commit .
814 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
815 5c860e29 2018-03-12 stsp .Ex -std got
816 97925469 2018-03-17 stsp .Sh EXAMPLES
817 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
819 fa6e0e48 2019-05-23 stsp This step currently requires
820 fa6e0e48 2019-05-23 stsp .Xr git 1 :
822 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
823 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
825 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
827 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
828 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
829 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
831 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
832 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
834 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
836 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
838 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
840 e70c17ce 2019-05-22 stsp .Dl $ got status
841 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
843 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
845 4e759de4 2019-06-26 stsp .Dl $ got branch -l
847 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
848 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
849 d83d9d5c 2019-05-13 stsp which is forked off the
853 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
855 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
856 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
857 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
859 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
861 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
862 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
864 fa6e0e48 2019-05-23 stsp .Dl $ got commit
866 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
867 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
868 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
870 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
872 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
874 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
875 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
877 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
878 e70c17ce 2019-05-22 stsp with a pre-defined log message.
880 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
882 95fc3404 2019-07-15 stsp Update any work tree checked out from the
883 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
884 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
886 95fc3404 2019-07-15 stsp .Dl $ got update
888 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
889 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
890 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
892 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
893 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
894 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
895 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
897 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
898 9221fb1e 2019-06-26 stsp This step currently requires
899 9221fb1e 2019-06-26 stsp .Xr git 1 :
901 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
902 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
905 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
906 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
910 818c7501 2019-07-11 stsp .Dl $ got update -b master
911 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
913 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
914 7d7ffedb 2019-07-14 stsp The patch can be mailed out for review and applied to OpenBSD's CVS tree:
916 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
918 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
919 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
922 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
923 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
924 0ebf8283 2019-07-24 stsp .Dl $ got histedit
926 5c860e29 2018-03-12 stsp .Sh SEE ALSO
927 2312fc47 2019-07-15 stsp .Xr tog 1 ,
928 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
929 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
930 1a208aaf 2018-04-01 stsp .Sh AUTHORS
931 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
932 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
933 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
934 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
936 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
937 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
939 b48be8cf 2019-07-14 stsp to perform tasks related to repository administration and tasks
940 b48be8cf 2019-07-14 stsp which require a network connection.
942 fa6e0e48 2019-05-23 stsp When working against a repository created with
943 fa6e0e48 2019-05-23 stsp .Dq git clone --bare ,
944 fa6e0e48 2019-05-23 stsp local commits to the
946 fa6e0e48 2019-05-23 stsp branch are discouraged, for now, if changes committed to the upstream
947 fa6e0e48 2019-05-23 stsp repository need to be tracked.
948 fa6e0e48 2019-05-23 stsp See the EXAMPLES section.
949 723bd6d4 2019-07-14 stsp Future built-in
953 723bd6d4 2019-07-14 stsp commands should alleviate this problem.
