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.
58 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
61 38e11793 2018-06-13 stsp The commands for
63 38e11793 2018-06-13 stsp are as follows:
64 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
65 09ea71ba 2019-07-27 stsp .It Cm init Ar repository-path
66 2c7829a4 2019-06-17 stsp Create a new empty repository at the specified
67 09ea71ba 2019-07-27 stsp .Ar repository-path .
70 3ce1b845 2019-07-15 stsp .Cm got init ,
72 3ce1b845 2019-07-15 stsp .Cm got import
73 3ce1b845 2019-07-15 stsp command must be used to populate the empty repository before
74 3ce1b845 2019-07-15 stsp .Cm got checkout
75 3ce1b845 2019-07-15 stsp can be used.
77 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
78 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
79 3ce1b845 2019-07-15 stsp within the specified
80 3ce1b845 2019-07-15 stsp .Ar directory .
81 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
82 3ce1b845 2019-07-15 stsp root commit.
83 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
84 3ce1b845 2019-07-15 stsp created commit.
85 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
88 21a44f98 2019-07-15 stsp .Cm got import
89 21a44f98 2019-07-15 stsp command requires the
90 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
91 21a44f98 2019-07-15 stsp environment variable to be set.
93 3ce1b845 2019-07-15 stsp The options for
94 3ce1b845 2019-07-15 stsp .Cm got import
95 3ce1b845 2019-07-15 stsp are as follows:
96 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
97 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
98 3ce1b845 2019-07-15 stsp Create the specified
100 3ce1b845 2019-07-15 stsp instead of creating the default branch
101 3ce1b845 2019-07-15 stsp .Dq master .
102 3ce1b845 2019-07-15 stsp Use of this option is required if the
104 3ce1b845 2019-07-15 stsp branch already exists.
105 3ce1b845 2019-07-15 stsp .It Fl m Ar message
106 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
107 3ce1b845 2019-07-15 stsp Without the
110 3ce1b845 2019-07-15 stsp .Cm got import
111 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
112 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
113 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
114 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
115 3ce1b845 2019-07-15 stsp working directory.
116 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
117 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
118 3ce1b845 2019-07-15 stsp .Ar pattern .
119 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
121 3ce1b845 2019-07-15 stsp .Ar pattern
122 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
123 3ce1b845 2019-07-15 stsp .Xr glob 7 .
125 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 ]
126 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
128 5d7c1dab 2018-04-01 stsp .Ar work tree path
129 c844a238 2019-02-06 stsp is not specified, either use the last component of
130 5d7c1dab 2018-04-01 stsp .Ar repository path ,
132 5d7c1dab 2018-04-01 stsp .Ar path prefix
133 c844a238 2019-02-06 stsp was specified use the last component of
134 5d7c1dab 2018-04-01 stsp .Ar path prefix .
136 38e11793 2018-06-13 stsp The options for
137 38e11793 2018-06-13 stsp .Cm got checkout
138 38e11793 2018-06-13 stsp are as follows:
139 38e11793 2018-06-13 stsp .Bl -tag -width Ds
140 08573d5b 2019-05-14 stsp .It Fl b Ar branch
141 3c575567 2019-07-28 stsp Check out files from a commit on the specified
142 08573d5b 2019-05-14 stsp .Ar branch .
143 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
144 08573d5b 2019-05-14 stsp reference will be used.
145 8069f636 2019-01-12 stsp .It Fl c Ar commit
146 8069f636 2019-01-12 stsp Check out files from the specified
148 3c575567 2019-07-28 stsp on the selected branch.
149 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
150 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
151 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
152 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
153 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
154 08573d5b 2019-05-14 stsp branch will be used.
155 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
156 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
157 38e11793 2018-06-13 stsp Only files beneath the specified
158 38e11793 2018-06-13 stsp .Ar path-prefix
159 38e11793 2018-06-13 stsp will be checked out.
162 97b3a7be 2019-07-09 stsp Short alias for
163 97b3a7be 2019-07-09 stsp .Cm checkout .
164 f2ea84fa 2019-07-27 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ... ]
165 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
166 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
167 7f838b36 2019-02-08 stsp .Bl -column YXZ description
168 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
169 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
170 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
171 7f838b36 2019-02-08 stsp .It D Ta file was deleted
172 7f838b36 2019-02-08 stsp .It A Ta new file was added
173 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
174 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
179 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
180 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
181 f2ea84fa 2019-07-27 stsp specified paths.
182 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
183 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
184 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
187 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
188 c4cdcb68 2019-04-03 stsp multiple base commits.
189 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
190 47ec7be7 2019-05-12 stsp .Cm got update
191 47ec7be7 2019-05-12 stsp across the entire work tree.
192 024e9686 2019-05-14 stsp Specifying a
194 024e9686 2019-05-14 stsp is incompatible with the
198 507dc3bb 2018-12-29 stsp The options for
199 507dc3bb 2018-12-29 stsp .Cm got update
200 507dc3bb 2018-12-29 stsp are as follows:
201 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
202 024e9686 2019-05-14 stsp .It Fl b Ar branch
203 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
205 024e9686 2019-05-14 stsp before updating the work tree.
206 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
207 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
208 507dc3bb 2018-12-29 stsp Update the work tree to the specified
209 507dc3bb 2018-12-29 stsp .Ar commit .
210 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
211 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
212 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
213 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
214 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
215 024e9686 2019-05-14 stsp branch will be used.
218 97b3a7be 2019-07-09 stsp Short alias for
219 97b3a7be 2019-07-09 stsp .Cm update .
220 72ea6654 2019-07-27 stsp .It Cm status [ Ar path ... ]
221 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
222 6bad629b 2019-02-04 stsp using the following status codes:
223 6bad629b 2019-02-04 stsp .Bl -column YXZ description
224 6bad629b 2019-02-04 stsp .It M Ta modified file
225 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
226 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
227 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
228 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
229 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
230 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
236 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
237 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
239 97b3a7be 2019-07-09 stsp Short alias for
240 97b3a7be 2019-07-09 stsp .Cm status .
241 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 ]
242 38e11793 2018-06-13 stsp Display history of a repository.
245 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
247 38e11793 2018-06-13 stsp The options for
248 38e11793 2018-06-13 stsp .Cm got log
249 38e11793 2018-06-13 stsp are as follows:
250 38e11793 2018-06-13 stsp .Bl -tag -width Ds
251 38e11793 2018-06-13 stsp .It Fl c Ar commit
252 38e11793 2018-06-13 stsp Start traversing history at the specified
253 38e11793 2018-06-13 stsp .Ar commit .
254 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
255 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
256 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
257 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
258 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
259 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
260 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
261 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
263 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
265 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
266 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
267 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
268 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
269 6238ee32 2018-06-13 stsp .It Fl l Ar N
270 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
272 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
273 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
274 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
275 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
276 04ca23f4 2018-07-16 stsp working directory.
277 e9cf2e30 2019-02-05 stsp If this directory is a
279 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
281 927df6b7 2019-02-10 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
282 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
283 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
286 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
288 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
289 a54b6686 2019-06-28 stsp or an object ID SHA1 hash, and display differences between these objects.
290 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
291 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
292 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
294 c0cc5c62 2018-10-18 stsp The options for
295 c0cc5c62 2018-10-18 stsp .Cm got diff
296 c0cc5c62 2018-10-18 stsp are as follows:
297 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
298 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
299 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
300 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
301 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
302 b72f483a 2019-02-05 stsp Use the repository at the specified path.
303 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
304 b72f483a 2019-02-05 stsp working directory.
305 b72f483a 2019-02-05 stsp If this directory is a
307 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
309 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
310 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
312 1ff8e573 2018-08-02 stsp The options for
313 1ff8e573 2018-08-02 stsp .Cm got blame
314 1ff8e573 2018-08-02 stsp are as follows:
315 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
316 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
317 1ff8e573 2018-08-02 stsp Start traversing history at the specified
318 1ff8e573 2018-08-02 stsp .Ar commit .
319 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
320 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
321 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
322 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
323 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
324 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
325 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
326 1ff8e573 2018-08-02 stsp working directory.
327 0c06baac 2019-02-05 stsp If this directory is a
329 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
331 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
332 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
333 5de5890b 2018-10-18 stsp directory path in the repository.
334 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
335 db0c2996 2019-02-10 stsp annotations:
336 db0c2996 2019-02-10 stsp .Bl -column YXZ description
337 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
338 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
343 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
344 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
345 0c849583 2019-02-05 stsp if there is no work tree.
347 5de5890b 2018-10-18 stsp The options for
348 5de5890b 2018-10-18 stsp .Cm got tree
349 5de5890b 2018-10-18 stsp are as follows:
350 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
351 5de5890b 2018-10-18 stsp .It Fl c Ar commit
352 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
353 5de5890b 2018-10-18 stsp .Ar commit .
354 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
355 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
356 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
357 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
358 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
359 5de5890b 2018-10-18 stsp Use the repository at the specified path.
360 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
361 5de5890b 2018-10-18 stsp working directory.
362 0c849583 2019-02-05 stsp If this directory is a
364 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
366 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
368 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
370 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
371 d0eebce4 2019-03-11 stsp Manage references in a repository.
373 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
374 d0eebce4 2019-03-11 stsp or update, the reference with the given
376 d0eebce4 2019-03-11 stsp and make it point at the given
377 d83d9d5c 2019-05-13 stsp .Ar target .
378 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
379 a54b6686 2019-06-28 stsp will be resolved to an object ID.
380 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
381 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
383 d0eebce4 2019-03-11 stsp The options for
384 d0eebce4 2019-03-11 stsp .Cm got ref
385 d0eebce4 2019-03-11 stsp are as follows:
386 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
387 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
388 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
389 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
390 d0eebce4 2019-03-11 stsp working directory.
391 d0eebce4 2019-03-11 stsp If this directory is a
393 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
395 d0eebce4 2019-03-11 stsp List all existing references in the repository.
396 d0eebce4 2019-03-11 stsp .It Fl d Ar name
397 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
399 4e759de4 2019-06-26 stsp .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
400 4e759de4 2019-06-26 stsp Manage branches in a repository.
402 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
403 4e759de4 2019-06-26 stsp .Dq refs/heads/
404 4e759de4 2019-06-26 stsp reference namespace.
406 4e759de4 2019-06-26 stsp .Cm got branch
407 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
409 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
410 4e759de4 2019-06-26 stsp a branch with the given
412 4e759de4 2019-06-26 stsp and make it point at the given
413 4e759de4 2019-06-26 stsp .Ar base-branch .
415 4e759de4 2019-06-26 stsp .Ar base-branch
416 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
417 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
419 4e759de4 2019-06-26 stsp The options for
420 4e759de4 2019-06-26 stsp .Cm got branch
421 4e759de4 2019-06-26 stsp are as follows:
422 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
423 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
424 4e759de4 2019-06-26 stsp Use the repository at the specified path.
425 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
426 4e759de4 2019-06-26 stsp working directory.
427 4e759de4 2019-06-26 stsp If this directory is a
429 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
431 4e759de4 2019-06-26 stsp List all existing branches in the repository.
432 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
433 ba882ee3 2019-07-11 stsp with one the following annotations:
434 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
435 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
436 ba882ee3 2019-07-11 stsp .It ~ Ta work tree's base commit is out-of-date
438 4e759de4 2019-06-26 stsp .It Fl d Ar name
439 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
440 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
441 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
442 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
443 ce33d90e 2019-07-14 stsp Git's garbage collector.
446 97b3a7be 2019-07-09 stsp Short alias for
447 97b3a7be 2019-07-09 stsp .Cm branch .
448 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
449 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
450 d00136be 2019-03-26 stsp repository in the next commit.
451 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
452 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
453 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
455 2ec1f75b 2019-03-26 stsp The options for
456 86d25a1b 2019-07-11 stsp .Cm got remove
457 2ec1f75b 2019-03-26 stsp are as follows:
458 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
460 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
463 648e4ef7 2019-07-09 stsp Short alias for
464 648e4ef7 2019-07-09 stsp .Cm remove .
465 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
466 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
467 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
468 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
469 a129376b 2019-03-28 stsp changes back after
470 a129376b 2019-03-28 stsp .Cm got revert !
472 e20a8b6f 2019-06-04 stsp If a file was added with
473 a129376b 2019-03-28 stsp .Cm got add
474 a129376b 2019-03-28 stsp it will become an unversioned file again.
475 e20a8b6f 2019-06-04 stsp If a file was deleted with
476 86d25a1b 2019-07-11 stsp .Cm got remove
477 a129376b 2019-03-28 stsp it will be restored.
479 97b3a7be 2019-07-09 stsp Short alias for
480 97b3a7be 2019-07-09 stsp .Cm revert .
481 5c1e53bc 2019-07-28 stsp .It Cm commit [ Fl m Ar message ] [ path ... ]
482 15cd91f7 2019-05-12 stsp Create a new commit in the repository from local changes in a work tree
483 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
486 5c1e53bc 2019-07-28 stsp is specified, commit all local changes in the work tree.
487 5c1e53bc 2019-07-28 stsp Otherwise, commit local changes at or within the specified paths.
489 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
490 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
491 15cd91f7 2019-05-12 stsp .It M Ta modified file
492 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
493 15cd91f7 2019-05-12 stsp .It A Ta new file was added
496 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
500 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
501 15cd91f7 2019-05-12 stsp multiple base commits.
502 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
503 47ec7be7 2019-05-12 stsp .Cm got update
504 47ec7be7 2019-05-12 stsp across the entire work tree.
507 15cd91f7 2019-05-12 stsp .Cm got commit
508 15cd91f7 2019-05-12 stsp command requires the
509 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
510 74416c47 2019-05-09 stsp environment variable to be set.
512 74416c47 2019-05-09 stsp The options for
513 74416c47 2019-05-09 stsp .Cm got commit
514 74416c47 2019-05-09 stsp are as follows:
515 74416c47 2019-05-09 stsp .Bl -tag -width Ds
516 74ff3f23 2019-07-07 stsp .It Fl m Ar message
517 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
518 23594da9 2019-05-13 stsp Without the
521 23594da9 2019-05-13 stsp .Cm got commit
522 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
525 cfce0458 2019-07-28 stsp .Cm got commit
526 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
527 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
528 916f288c 2019-07-30 stsp .Dq refs/heads/
529 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
530 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
531 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
532 cfce0458 2019-07-28 stsp If a path is found to be out of date,
533 cfce0458 2019-07-28 stsp .Cm got update
534 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
535 cfce0458 2019-07-28 stsp in the repository.
537 97b3a7be 2019-07-09 stsp Short alias for
538 97b3a7be 2019-07-09 stsp .Cm commit .
539 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
540 234035bc 2019-06-01 stsp Merge changes from a single
542 234035bc 2019-06-01 stsp into the work tree.
543 234035bc 2019-06-01 stsp The specified
545 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
546 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
547 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
548 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
550 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
551 234035bc 2019-06-01 stsp .Bl -column YXZ description
552 234035bc 2019-06-01 stsp .It G Ta file was merged
553 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
554 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
555 234035bc 2019-06-01 stsp .It D Ta file was deleted
556 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
557 234035bc 2019-06-01 stsp .It A Ta new file was added
558 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
561 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
562 234035bc 2019-06-01 stsp may be viewed with
563 234035bc 2019-06-01 stsp .Cm got diff ,
564 234035bc 2019-06-01 stsp amended manually or with further
565 234035bc 2019-06-01 stsp .Cm got cherrypick
567 234035bc 2019-06-01 stsp committed with
568 234035bc 2019-06-01 stsp .Cm got commit ,
569 234035bc 2019-06-01 stsp or discarded again with
570 234035bc 2019-06-01 stsp .Cm got revert .
572 234035bc 2019-06-01 stsp .Cm got cherrypick
573 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
574 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
575 234035bc 2019-06-01 stsp to a single base commit with
576 234035bc 2019-06-01 stsp .Cm got update .
577 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
578 234035bc 2019-06-01 stsp conflicts must be resolved first.
580 97b3a7be 2019-07-09 stsp Short alias for
581 97b3a7be 2019-07-09 stsp .Cm cherrypick .
582 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
583 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
585 5ef14e63 2019-06-02 stsp into the work tree.
586 5ef14e63 2019-06-02 stsp The specified
588 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
589 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
590 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
591 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
593 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
594 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
595 5ef14e63 2019-06-02 stsp .It G Ta file was merged
596 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
597 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
598 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
599 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
600 5ef14e63 2019-06-02 stsp .It A Ta new file was added
601 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
604 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
605 5ef14e63 2019-06-02 stsp which may be viewed with
606 5ef14e63 2019-06-02 stsp .Cm got diff ,
607 5ef14e63 2019-06-02 stsp amended manually or with further
608 778a73c2 2019-07-12 stsp .Cm got backout
610 5ef14e63 2019-06-02 stsp committed with
611 5ef14e63 2019-06-02 stsp .Cm got commit ,
612 5ef14e63 2019-06-02 stsp or discarded again with
613 5ef14e63 2019-06-02 stsp .Cm got revert .
615 92228c38 2019-06-02 stsp .Cm got backout
616 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
617 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
618 92228c38 2019-06-02 stsp to a single base commit with
619 92228c38 2019-06-02 stsp .Cm got update .
620 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
621 92228c38 2019-06-02 stsp conflicts must be resolved first.
623 97b3a7be 2019-07-09 stsp Short alias for
624 97b3a7be 2019-07-09 stsp .Cm backout .
625 cd98404f 2019-07-14 stsp .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
626 818c7501 2019-07-11 stsp Rebase commits on the specified
628 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
631 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
632 f09e2405 2019-07-11 stsp Rebasing begins with the first descendent commit of the youngest
633 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
635 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
636 f09e2405 2019-07-11 stsp of the specified
638 f09e2405 2019-07-11 stsp has been rebased.
640 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
641 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
642 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
643 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
644 818c7501 2019-07-11 stsp .Ar branch ,
645 818c7501 2019-07-11 stsp but with different commit IDs.
646 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
647 f09e2405 2019-07-11 stsp the new version of the specified
649 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
651 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
652 818c7501 2019-07-11 stsp using the following status codes:
653 818c7501 2019-07-11 stsp .Bl -column YXZ description
654 818c7501 2019-07-11 stsp .It G Ta file was merged
655 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
656 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
657 818c7501 2019-07-11 stsp .It D Ta file was deleted
658 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
659 818c7501 2019-07-11 stsp .It A Ta new file was added
660 818c7501 2019-07-11 stsp .It ~ Ta changes destined for a non-regular file were not merged
663 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
664 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
665 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
667 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
669 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
670 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
671 f09e2405 2019-07-11 stsp when the rebase operation continues.
673 818c7501 2019-07-11 stsp .Cm got rebase
674 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
675 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
676 818c7501 2019-07-11 stsp to a single base commit with
677 818c7501 2019-07-11 stsp .Cm got update .
678 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
679 f09e2405 2019-07-11 stsp committed with
680 f09e2405 2019-07-11 stsp .Cm got commit
681 f09e2405 2019-07-11 stsp or reverted with
682 f09e2405 2019-07-11 stsp .Cm got revert .
685 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
686 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
689 7d5807f4 2019-07-11 stsp .Cm got update
691 7d5807f4 2019-07-11 stsp .Cm got commit
692 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
693 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
694 7d5807f4 2019-07-11 stsp conflict resolution purposes.
696 818c7501 2019-07-11 stsp The options for
697 818c7501 2019-07-11 stsp .Cm got rebase
698 818c7501 2019-07-11 stsp are as follows:
699 818c7501 2019-07-11 stsp .Bl -tag -width Ds
701 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
702 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
704 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
705 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
708 818c7501 2019-07-11 stsp Short alias for
709 818c7501 2019-07-11 stsp .Cm rebase .
710 0ebf8283 2019-07-24 stsp .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
711 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
712 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
714 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
715 0ebf8283 2019-07-24 stsp .Ar histedit script
716 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
717 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
718 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
719 0ebf8283 2019-07-24 stsp whitespace and an argument.
720 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
721 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
722 0ebf8283 2019-07-24 stsp Lines which begin with the
724 0ebf8283 2019-07-24 stsp character are ignored entirely.
726 0ebf8283 2019-07-24 stsp The available commands are as follows:
727 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
728 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
729 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
730 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
731 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
732 0ebf8283 2019-07-24 stsp listed further below that will be used.
733 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
734 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
735 0ebf8283 2019-07-24 stsp the commit on the previous line.
736 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
737 0ebf8283 2019-07-24 stsp log message can be written.
740 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
741 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
743 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
744 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
745 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
746 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
747 498a90b7 2019-07-25 stsp switched to it.
749 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
750 0ebf8283 2019-07-24 stsp using the following status codes:
751 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
752 0ebf8283 2019-07-24 stsp .It G Ta file was merged
753 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
754 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
755 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
756 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
757 0ebf8283 2019-07-24 stsp .It A Ta new file was added
758 0ebf8283 2019-07-24 stsp .It ~ Ta changes destined for a non-regular file were not merged
761 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
762 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
763 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
764 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
766 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
767 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
768 0ebf8283 2019-07-24 stsp when the histedit operation continues.
770 0ebf8283 2019-07-24 stsp .Cm got histedit
771 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
772 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
773 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
774 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
775 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
776 0ebf8283 2019-07-24 stsp to a single base commit with
777 0ebf8283 2019-07-24 stsp .Cm got update .
778 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
779 0ebf8283 2019-07-24 stsp committed with
780 0ebf8283 2019-07-24 stsp .Cm got commit
781 0ebf8283 2019-07-24 stsp or reverted with
782 0ebf8283 2019-07-24 stsp .Cm got revert .
783 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
784 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
787 0ebf8283 2019-07-24 stsp .Cm got update
788 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
789 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
790 0ebf8283 2019-07-24 stsp .Cm got commit
791 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
792 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
794 0ebf8283 2019-07-24 stsp The options for
795 0ebf8283 2019-07-24 stsp .Cm got histedit
796 0ebf8283 2019-07-24 stsp are as follows:
797 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
799 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
800 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
802 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
803 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
806 0ebf8283 2019-07-24 stsp Short alias for
807 0ebf8283 2019-07-24 stsp .Cm histedit .
809 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
810 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
811 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
812 74416c47 2019-05-09 stsp The author's name and email address for
813 21a44f98 2019-07-15 stsp .Cm got commit
815 21a44f98 2019-07-15 stsp .Cm got import ,
816 74416c47 2019-05-09 stsp for example:
817 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
818 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
819 23594da9 2019-05-13 stsp The editor spawned by
820 23594da9 2019-05-13 stsp .Cm got commit .
822 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
823 5c860e29 2018-03-12 stsp .Ex -std got
824 97925469 2018-03-17 stsp .Sh EXAMPLES
825 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
827 fa6e0e48 2019-05-23 stsp This step currently requires
828 fa6e0e48 2019-05-23 stsp .Xr git 1 :
830 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
831 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
833 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
835 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
836 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
837 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
839 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
840 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
842 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
844 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
846 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
848 e70c17ce 2019-05-22 stsp .Dl $ got status
849 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
851 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
853 4e759de4 2019-06-26 stsp .Dl $ got branch -l
855 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
856 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
857 d83d9d5c 2019-05-13 stsp which is forked off the
861 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
863 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
864 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
865 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
867 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
869 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
870 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
872 fa6e0e48 2019-05-23 stsp .Dl $ got commit
874 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
875 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
876 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
878 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
880 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
882 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
883 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
885 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
886 e70c17ce 2019-05-22 stsp with a pre-defined log message.
888 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
890 95fc3404 2019-07-15 stsp Update any work tree checked out from the
891 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
892 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
894 95fc3404 2019-07-15 stsp .Dl $ got update
896 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
897 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
898 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
900 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
901 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
902 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
903 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
905 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
906 9221fb1e 2019-06-26 stsp This step currently requires
907 9221fb1e 2019-06-26 stsp .Xr git 1 :
909 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
910 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
913 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
914 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
918 818c7501 2019-07-11 stsp .Dl $ got update -b master
919 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
921 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
922 7d7ffedb 2019-07-14 stsp The patch can be mailed out for review and applied to OpenBSD's CVS tree:
924 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
926 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
927 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
930 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
931 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
932 0ebf8283 2019-07-24 stsp .Dl $ got histedit
934 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
935 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
936 7b3fde24 2019-07-28 stsp .Cm git fetch
938 7b3fde24 2019-07-28 stsp .Cm git push .
939 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
940 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
942 ff2cf171 2019-07-28 stsp .Dq refspec
943 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
945 ff2cf171 2019-07-28 stsp .Dq refs/remotes
946 ff2cf171 2019-07-28 stsp namespace of the local repository.
947 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
948 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
949 ff2cf171 2019-07-28 stsp configuration variable to the value
950 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
952 ff2cf171 2019-07-28 stsp .Cm git config
955 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
956 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
958 ff2cf171 2019-07-28 stsp Alternatively, the following
960 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
964 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
965 ff2cf171 2019-07-28 stsp .Dl url = ...
966 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
968 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
969 ff2cf171 2019-07-28 stsp .Dq refs/heads
970 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
971 ff2cf171 2019-07-28 stsp .Cm got checkout
972 ff2cf171 2019-07-28 stsp and, if needed, created with
973 ff2cf171 2019-07-28 stsp .Cm got branch .
975 ff2cf171 2019-07-28 stsp Branches in the
976 ff2cf171 2019-07-28 stsp .Dq remotes/origin
977 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
978 ff2cf171 2019-07-28 stsp repository with
979 ff2cf171 2019-07-28 stsp .Cm git fetch :
981 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
982 ff2cf171 2019-07-28 stsp .Dl $ git fetch
984 ff2cf171 2019-07-28 stsp Before outgoing changes on the local
986 ff2cf171 2019-07-28 stsp branch can be pushed to the remote repository, the local
988 ff2cf171 2019-07-28 stsp branch must be rebased onto the
989 ff2cf171 2019-07-28 stsp .Dq origin/master
992 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
993 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
995 ff2cf171 2019-07-28 stsp Changes on the local
997 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
998 ff2cf171 2019-07-28 stsp repository with
999 ff2cf171 2019-07-28 stsp .Cm git push :
1001 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1002 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1004 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1005 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1006 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1007 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1008 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1009 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1010 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1011 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
1012 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1014 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1015 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1017 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1018 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
