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 08573d5b 2019-05-14 stsp Check out files from 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
145 8069f636 2019-01-12 stsp .Ar commit .
146 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
147 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
148 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
149 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
150 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
151 08573d5b 2019-05-14 stsp branch will be used.
152 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
153 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
154 38e11793 2018-06-13 stsp Only files beneath the specified
155 38e11793 2018-06-13 stsp .Ar path-prefix
156 38e11793 2018-06-13 stsp will be checked out.
159 97b3a7be 2019-07-09 stsp Short alias for
160 97b3a7be 2019-07-09 stsp .Cm checkout .
161 f2ea84fa 2019-07-27 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ... ]
162 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
163 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
164 7f838b36 2019-02-08 stsp .Bl -column YXZ description
165 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
166 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
167 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
168 7f838b36 2019-02-08 stsp .It D Ta file was deleted
169 7f838b36 2019-02-08 stsp .It A Ta new file was added
170 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
171 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
176 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
177 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
178 f2ea84fa 2019-07-27 stsp specified paths.
179 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
180 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
181 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
184 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
185 c4cdcb68 2019-04-03 stsp multiple base commits.
186 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
187 47ec7be7 2019-05-12 stsp .Cm got update
188 47ec7be7 2019-05-12 stsp across the entire work tree.
189 024e9686 2019-05-14 stsp Specifying a
191 024e9686 2019-05-14 stsp is incompatible with the
195 507dc3bb 2018-12-29 stsp The options for
196 507dc3bb 2018-12-29 stsp .Cm got update
197 507dc3bb 2018-12-29 stsp are as follows:
198 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
199 024e9686 2019-05-14 stsp .It Fl b Ar branch
200 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
202 024e9686 2019-05-14 stsp before updating the work tree.
203 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
204 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
205 507dc3bb 2018-12-29 stsp Update the work tree to the specified
206 507dc3bb 2018-12-29 stsp .Ar commit .
207 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
208 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
209 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
210 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
211 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
212 024e9686 2019-05-14 stsp branch will be used.
215 97b3a7be 2019-07-09 stsp Short alias for
216 97b3a7be 2019-07-09 stsp .Cm update .
217 72ea6654 2019-07-27 stsp .It Cm status [ Ar path ... ]
218 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
219 6bad629b 2019-02-04 stsp using the following status codes:
220 6bad629b 2019-02-04 stsp .Bl -column YXZ description
221 6bad629b 2019-02-04 stsp .It M Ta modified file
222 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
223 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
224 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
225 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
226 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
227 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
233 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
234 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
236 97b3a7be 2019-07-09 stsp Short alias for
237 97b3a7be 2019-07-09 stsp .Cm status .
238 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 ]
239 38e11793 2018-06-13 stsp Display history of a repository.
242 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
244 38e11793 2018-06-13 stsp The options for
245 38e11793 2018-06-13 stsp .Cm got log
246 38e11793 2018-06-13 stsp are as follows:
247 38e11793 2018-06-13 stsp .Bl -tag -width Ds
248 38e11793 2018-06-13 stsp .It Fl c Ar commit
249 38e11793 2018-06-13 stsp Start traversing history at the specified
250 38e11793 2018-06-13 stsp .Ar commit .
251 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
252 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
253 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
254 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
255 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
256 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
257 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
258 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
260 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
262 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
263 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
264 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
265 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
266 6238ee32 2018-06-13 stsp .It Fl l Ar N
267 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
269 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
270 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
271 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
272 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
273 04ca23f4 2018-07-16 stsp working directory.
274 e9cf2e30 2019-02-05 stsp If this directory is a
276 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
278 927df6b7 2019-02-10 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
279 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
280 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
283 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
285 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
286 a54b6686 2019-06-28 stsp or an object ID SHA1 hash, and display differences between these objects.
287 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
288 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
289 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
291 c0cc5c62 2018-10-18 stsp The options for
292 c0cc5c62 2018-10-18 stsp .Cm got diff
293 c0cc5c62 2018-10-18 stsp are as follows:
294 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
295 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
296 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
297 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
298 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
299 b72f483a 2019-02-05 stsp Use the repository at the specified path.
300 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
301 b72f483a 2019-02-05 stsp working directory.
302 b72f483a 2019-02-05 stsp If this directory is a
304 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
306 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
307 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
309 1ff8e573 2018-08-02 stsp The options for
310 1ff8e573 2018-08-02 stsp .Cm got blame
311 1ff8e573 2018-08-02 stsp are as follows:
312 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
313 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
314 1ff8e573 2018-08-02 stsp Start traversing history at the specified
315 1ff8e573 2018-08-02 stsp .Ar commit .
316 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
317 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
318 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
319 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
320 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
321 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
322 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
323 1ff8e573 2018-08-02 stsp working directory.
324 0c06baac 2019-02-05 stsp If this directory is a
326 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
328 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
329 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
330 5de5890b 2018-10-18 stsp directory path in the repository.
331 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
332 db0c2996 2019-02-10 stsp annotations:
333 db0c2996 2019-02-10 stsp .Bl -column YXZ description
334 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
335 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
340 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
341 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
342 0c849583 2019-02-05 stsp if there is no work tree.
344 5de5890b 2018-10-18 stsp The options for
345 5de5890b 2018-10-18 stsp .Cm got tree
346 5de5890b 2018-10-18 stsp are as follows:
347 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
348 5de5890b 2018-10-18 stsp .It Fl c Ar commit
349 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
350 5de5890b 2018-10-18 stsp .Ar commit .
351 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
352 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
353 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
354 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
355 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
356 5de5890b 2018-10-18 stsp Use the repository at the specified path.
357 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
358 5de5890b 2018-10-18 stsp working directory.
359 0c849583 2019-02-05 stsp If this directory is a
361 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
363 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
365 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
367 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
368 d0eebce4 2019-03-11 stsp Manage references in a repository.
370 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
371 d0eebce4 2019-03-11 stsp or update, the reference with the given
373 d0eebce4 2019-03-11 stsp and make it point at the given
374 d83d9d5c 2019-05-13 stsp .Ar target .
375 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
376 a54b6686 2019-06-28 stsp will be resolved to an object ID.
377 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
378 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
380 d0eebce4 2019-03-11 stsp The options for
381 d0eebce4 2019-03-11 stsp .Cm got ref
382 d0eebce4 2019-03-11 stsp are as follows:
383 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
384 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
385 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
386 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
387 d0eebce4 2019-03-11 stsp working directory.
388 d0eebce4 2019-03-11 stsp If this directory is a
390 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
392 d0eebce4 2019-03-11 stsp List all existing references in the repository.
393 d0eebce4 2019-03-11 stsp .It Fl d Ar name
394 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
396 4e759de4 2019-06-26 stsp .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
397 4e759de4 2019-06-26 stsp Manage branches in a repository.
399 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
400 4e759de4 2019-06-26 stsp .Dq refs/heads/
401 4e759de4 2019-06-26 stsp reference namespace.
403 4e759de4 2019-06-26 stsp .Cm got branch
404 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
406 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
407 4e759de4 2019-06-26 stsp a branch with the given
409 4e759de4 2019-06-26 stsp and make it point at the given
410 4e759de4 2019-06-26 stsp .Ar base-branch .
412 4e759de4 2019-06-26 stsp .Ar base-branch
413 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
414 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
416 4e759de4 2019-06-26 stsp The options for
417 4e759de4 2019-06-26 stsp .Cm got branch
418 4e759de4 2019-06-26 stsp are as follows:
419 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
420 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
421 4e759de4 2019-06-26 stsp Use the repository at the specified path.
422 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
423 4e759de4 2019-06-26 stsp working directory.
424 4e759de4 2019-06-26 stsp If this directory is a
426 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
428 4e759de4 2019-06-26 stsp List all existing branches in the repository.
429 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
430 ba882ee3 2019-07-11 stsp with one the following annotations:
431 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
432 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
433 ba882ee3 2019-07-11 stsp .It ~ Ta work tree's base commit is out-of-date
435 4e759de4 2019-06-26 stsp .It Fl d Ar name
436 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
437 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
438 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
439 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
440 ce33d90e 2019-07-14 stsp Git's garbage collector.
443 97b3a7be 2019-07-09 stsp Short alias for
444 97b3a7be 2019-07-09 stsp .Cm branch .
445 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
446 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
447 d00136be 2019-03-26 stsp repository in the next commit.
448 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
449 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
450 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
452 2ec1f75b 2019-03-26 stsp The options for
453 86d25a1b 2019-07-11 stsp .Cm got remove
454 2ec1f75b 2019-03-26 stsp are as follows:
455 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
457 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
460 648e4ef7 2019-07-09 stsp Short alias for
461 648e4ef7 2019-07-09 stsp .Cm remove .
462 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
463 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
464 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
465 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
466 a129376b 2019-03-28 stsp changes back after
467 a129376b 2019-03-28 stsp .Cm got revert !
469 e20a8b6f 2019-06-04 stsp If a file was added with
470 a129376b 2019-03-28 stsp .Cm got add
471 a129376b 2019-03-28 stsp it will become an unversioned file again.
472 e20a8b6f 2019-06-04 stsp If a file was deleted with
473 86d25a1b 2019-07-11 stsp .Cm got remove
474 a129376b 2019-03-28 stsp it will be restored.
476 97b3a7be 2019-07-09 stsp Short alias for
477 97b3a7be 2019-07-09 stsp .Cm revert .
478 90e8619e 2019-07-25 stsp .It Cm commit [ Fl m Ar message ] [ path ]
479 15cd91f7 2019-05-12 stsp Create a new commit in the repository from local changes in a work tree
480 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
483 90e8619e 2019-07-25 stsp is specified, only commit local changes at or within this path.
485 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
486 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
487 15cd91f7 2019-05-12 stsp .It M Ta modified file
488 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
489 15cd91f7 2019-05-12 stsp .It A Ta new file was added
492 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
496 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
497 15cd91f7 2019-05-12 stsp multiple base commits.
498 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
499 47ec7be7 2019-05-12 stsp .Cm got update
500 47ec7be7 2019-05-12 stsp across the entire work tree.
503 15cd91f7 2019-05-12 stsp .Cm got commit
504 15cd91f7 2019-05-12 stsp command requires the
505 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
506 74416c47 2019-05-09 stsp environment variable to be set.
508 74416c47 2019-05-09 stsp The options for
509 74416c47 2019-05-09 stsp .Cm got commit
510 74416c47 2019-05-09 stsp are as follows:
511 74416c47 2019-05-09 stsp .Bl -tag -width Ds
512 74ff3f23 2019-07-07 stsp .It Fl m Ar message
513 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
514 23594da9 2019-05-13 stsp Without the
517 23594da9 2019-05-13 stsp .Cm got commit
518 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
521 97b3a7be 2019-07-09 stsp Short alias for
522 97b3a7be 2019-07-09 stsp .Cm commit .
523 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
524 234035bc 2019-06-01 stsp Merge changes from a single
526 234035bc 2019-06-01 stsp into the work tree.
527 234035bc 2019-06-01 stsp The specified
529 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
530 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
531 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
532 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
534 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
535 234035bc 2019-06-01 stsp .Bl -column YXZ description
536 234035bc 2019-06-01 stsp .It G Ta file was merged
537 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
538 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
539 234035bc 2019-06-01 stsp .It D Ta file was deleted
540 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
541 234035bc 2019-06-01 stsp .It A Ta new file was added
542 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
545 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
546 234035bc 2019-06-01 stsp may be viewed with
547 234035bc 2019-06-01 stsp .Cm got diff ,
548 234035bc 2019-06-01 stsp amended manually or with further
549 234035bc 2019-06-01 stsp .Cm got cherrypick
551 234035bc 2019-06-01 stsp committed with
552 234035bc 2019-06-01 stsp .Cm got commit ,
553 234035bc 2019-06-01 stsp or discarded again with
554 234035bc 2019-06-01 stsp .Cm got revert .
556 234035bc 2019-06-01 stsp .Cm got cherrypick
557 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
558 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
559 234035bc 2019-06-01 stsp to a single base commit with
560 234035bc 2019-06-01 stsp .Cm got update .
561 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
562 234035bc 2019-06-01 stsp conflicts must be resolved first.
564 97b3a7be 2019-07-09 stsp Short alias for
565 97b3a7be 2019-07-09 stsp .Cm cherrypick .
566 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
567 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
569 5ef14e63 2019-06-02 stsp into the work tree.
570 5ef14e63 2019-06-02 stsp The specified
572 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
573 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
574 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
575 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
577 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
578 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
579 5ef14e63 2019-06-02 stsp .It G Ta file was merged
580 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
581 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
582 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
583 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
584 5ef14e63 2019-06-02 stsp .It A Ta new file was added
585 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
588 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
589 5ef14e63 2019-06-02 stsp which may be viewed with
590 5ef14e63 2019-06-02 stsp .Cm got diff ,
591 5ef14e63 2019-06-02 stsp amended manually or with further
592 778a73c2 2019-07-12 stsp .Cm got backout
594 5ef14e63 2019-06-02 stsp committed with
595 5ef14e63 2019-06-02 stsp .Cm got commit ,
596 5ef14e63 2019-06-02 stsp or discarded again with
597 5ef14e63 2019-06-02 stsp .Cm got revert .
599 92228c38 2019-06-02 stsp .Cm got backout
600 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
601 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
602 92228c38 2019-06-02 stsp to a single base commit with
603 92228c38 2019-06-02 stsp .Cm got update .
604 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
605 92228c38 2019-06-02 stsp conflicts must be resolved first.
607 97b3a7be 2019-07-09 stsp Short alias for
608 97b3a7be 2019-07-09 stsp .Cm backout .
609 cd98404f 2019-07-14 stsp .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
610 818c7501 2019-07-11 stsp Rebase commits on the specified
612 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
615 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
616 f09e2405 2019-07-11 stsp Rebasing begins with the first descendent commit of the youngest
617 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
619 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
620 f09e2405 2019-07-11 stsp of the specified
622 f09e2405 2019-07-11 stsp has been rebased.
624 818c7501 2019-07-11 stsp Rebased commits are accumulated on a temporary branch and represent
625 f09e2405 2019-07-11 stsp the same changes with the same log messages as their counterparts
626 f09e2405 2019-07-11 stsp on the original
627 818c7501 2019-07-11 stsp .Ar branch ,
628 818c7501 2019-07-11 stsp but with different commit IDs.
629 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
630 f09e2405 2019-07-11 stsp the new version of the specified
632 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
634 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
635 818c7501 2019-07-11 stsp using the following status codes:
636 818c7501 2019-07-11 stsp .Bl -column YXZ description
637 818c7501 2019-07-11 stsp .It G Ta file was merged
638 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
639 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
640 818c7501 2019-07-11 stsp .It D Ta file was deleted
641 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
642 818c7501 2019-07-11 stsp .It A Ta new file was added
643 818c7501 2019-07-11 stsp .It ~ Ta changes destined for a non-regular file were not merged
646 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
647 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
648 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
650 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
652 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
653 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
654 f09e2405 2019-07-11 stsp when the rebase operation continues.
656 818c7501 2019-07-11 stsp .Cm got rebase
657 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
658 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
659 818c7501 2019-07-11 stsp to a single base commit with
660 818c7501 2019-07-11 stsp .Cm got update .
661 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
662 f09e2405 2019-07-11 stsp committed with
663 f09e2405 2019-07-11 stsp .Cm got commit
664 f09e2405 2019-07-11 stsp or reverted with
665 f09e2405 2019-07-11 stsp .Cm got revert .
668 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
669 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
672 7d5807f4 2019-07-11 stsp .Cm got update
674 7d5807f4 2019-07-11 stsp .Cm got commit
675 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
676 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
677 7d5807f4 2019-07-11 stsp conflict resolution purposes.
679 818c7501 2019-07-11 stsp The options for
680 818c7501 2019-07-11 stsp .Cm got rebase
681 818c7501 2019-07-11 stsp are as follows:
682 818c7501 2019-07-11 stsp .Bl -tag -width Ds
684 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
685 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
687 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
688 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
691 818c7501 2019-07-11 stsp Short alias for
692 818c7501 2019-07-11 stsp .Cm rebase .
693 0ebf8283 2019-07-24 stsp .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
694 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
695 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
697 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
698 0ebf8283 2019-07-24 stsp .Ar histedit script
699 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
700 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
701 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
702 0ebf8283 2019-07-24 stsp whitespace and an argument.
703 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
704 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
705 0ebf8283 2019-07-24 stsp Lines which begin with the
707 0ebf8283 2019-07-24 stsp character are ignored entirely.
709 0ebf8283 2019-07-24 stsp The available commands are as follows:
710 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
711 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
712 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
713 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
714 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
715 0ebf8283 2019-07-24 stsp listed further below that will be used.
716 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
717 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
718 0ebf8283 2019-07-24 stsp the commit on the previous line.
719 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
720 0ebf8283 2019-07-24 stsp log message can be written.
723 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
724 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
726 0ebf8283 2019-07-24 stsp Edited commits are accumulated on a temporary branch.
727 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
728 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
729 498a90b7 2019-07-25 stsp switched to it.
731 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
732 0ebf8283 2019-07-24 stsp using the following status codes:
733 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
734 0ebf8283 2019-07-24 stsp .It G Ta file was merged
735 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
736 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
737 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
738 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
739 0ebf8283 2019-07-24 stsp .It A Ta new file was added
740 0ebf8283 2019-07-24 stsp .It ~ Ta changes destined for a non-regular file were not merged
743 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
744 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
745 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
746 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
748 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
749 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
750 0ebf8283 2019-07-24 stsp when the histedit operation continues.
752 0ebf8283 2019-07-24 stsp .Cm got histedit
753 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
754 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
755 0ebf8283 2019-07-24 stsp to a single base commit with
756 0ebf8283 2019-07-24 stsp .Cm got update .
757 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
758 0ebf8283 2019-07-24 stsp committed with
759 0ebf8283 2019-07-24 stsp .Cm got commit
760 0ebf8283 2019-07-24 stsp or reverted with
761 0ebf8283 2019-07-24 stsp .Cm got revert .
762 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
763 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
766 0ebf8283 2019-07-24 stsp .Cm got update
767 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
768 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
769 0ebf8283 2019-07-24 stsp .Cm got commit
770 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
771 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
773 0ebf8283 2019-07-24 stsp The options for
774 0ebf8283 2019-07-24 stsp .Cm got histedit
775 0ebf8283 2019-07-24 stsp are as follows:
776 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
778 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
779 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
781 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
782 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
785 0ebf8283 2019-07-24 stsp Short alias for
786 0ebf8283 2019-07-24 stsp .Cm histedit .
788 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
789 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
790 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
791 74416c47 2019-05-09 stsp The author's name and email address for
792 21a44f98 2019-07-15 stsp .Cm got commit
794 21a44f98 2019-07-15 stsp .Cm got import ,
795 74416c47 2019-05-09 stsp for example:
796 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
797 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
798 23594da9 2019-05-13 stsp The editor spawned by
799 23594da9 2019-05-13 stsp .Cm got commit .
801 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
802 5c860e29 2018-03-12 stsp .Ex -std got
803 97925469 2018-03-17 stsp .Sh EXAMPLES
804 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
806 fa6e0e48 2019-05-23 stsp This step currently requires
807 fa6e0e48 2019-05-23 stsp .Xr git 1 :
809 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
810 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
812 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
814 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
815 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
816 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
818 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
819 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
821 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
823 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
825 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
827 e70c17ce 2019-05-22 stsp .Dl $ got status
828 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
830 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
832 4e759de4 2019-06-26 stsp .Dl $ got branch -l
834 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
835 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
836 d83d9d5c 2019-05-13 stsp which is forked off the
840 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
842 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
843 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
844 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
846 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
848 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
849 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
851 fa6e0e48 2019-05-23 stsp .Dl $ got commit
853 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
854 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
855 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
857 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
859 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
861 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
862 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
864 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
865 e70c17ce 2019-05-22 stsp with a pre-defined log message.
867 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
869 95fc3404 2019-07-15 stsp Update any work tree checked out from the
870 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
871 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
873 95fc3404 2019-07-15 stsp .Dl $ got update
875 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
876 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
877 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
879 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
880 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
881 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
882 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
884 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
885 9221fb1e 2019-06-26 stsp This step currently requires
886 9221fb1e 2019-06-26 stsp .Xr git 1 :
888 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
889 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
892 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
893 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
897 818c7501 2019-07-11 stsp .Dl $ got update -b master
898 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
900 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
901 7d7ffedb 2019-07-14 stsp The patch can be mailed out for review and applied to OpenBSD's CVS tree:
903 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
905 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
906 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
909 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
910 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
911 0ebf8283 2019-07-24 stsp .Dl $ got histedit
913 5c860e29 2018-03-12 stsp .Sh SEE ALSO
914 2312fc47 2019-07-15 stsp .Xr tog 1 ,
915 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
916 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
917 1a208aaf 2018-04-01 stsp .Sh AUTHORS
918 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
919 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
920 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
921 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
923 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
924 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
926 b48be8cf 2019-07-14 stsp to perform tasks related to repository administration and tasks
927 b48be8cf 2019-07-14 stsp which require a network connection.
929 fa6e0e48 2019-05-23 stsp When working against a repository created with
930 fa6e0e48 2019-05-23 stsp .Dq git clone --bare ,
931 fa6e0e48 2019-05-23 stsp local commits to the
933 fa6e0e48 2019-05-23 stsp branch are discouraged, for now, if changes committed to the upstream
934 fa6e0e48 2019-05-23 stsp repository need to be tracked.
935 fa6e0e48 2019-05-23 stsp See the EXAMPLES section.
936 723bd6d4 2019-07-14 stsp Future built-in
940 723bd6d4 2019-07-14 stsp commands should alleviate this problem.
