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 4ed9f614 2019-08-04 stsp .Cm got update
199 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
200 4ed9f614 2019-08-04 stsp If changes have been staged with
201 4ed9f614 2019-08-04 stsp .Cm got stage ,
202 4ed9f614 2019-08-04 stsp these changes must first be comitted with
203 4ed9f614 2019-08-04 stsp .Cm got commit
204 4ed9f614 2019-08-04 stsp or unstaged with
205 4ed9f614 2019-08-04 stsp .Cm got unstage .
207 507dc3bb 2018-12-29 stsp The options for
208 507dc3bb 2018-12-29 stsp .Cm got update
209 507dc3bb 2018-12-29 stsp are as follows:
210 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
211 024e9686 2019-05-14 stsp .It Fl b Ar branch
212 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
214 024e9686 2019-05-14 stsp before updating the work tree.
215 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
216 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
217 507dc3bb 2018-12-29 stsp Update the work tree to the specified
218 507dc3bb 2018-12-29 stsp .Ar commit .
219 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
220 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
221 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
222 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
223 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
224 024e9686 2019-05-14 stsp branch will be used.
227 97b3a7be 2019-07-09 stsp Short alias for
228 97b3a7be 2019-07-09 stsp .Cm update .
229 72ea6654 2019-07-27 stsp .It Cm status [ Ar path ... ]
230 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
231 6bad629b 2019-02-04 stsp using the following status codes:
232 6bad629b 2019-02-04 stsp .Bl -column YXZ description
233 6bad629b 2019-02-04 stsp .It M Ta modified file
234 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
235 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
236 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
237 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
238 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
239 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
245 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
246 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
248 4ed9f614 2019-08-04 stsp If changes have been staged with
249 4ed9f614 2019-08-04 stsp .Cm got stage ,
250 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
251 4ed9f614 2019-08-04 stsp status codes:
252 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
253 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
254 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
255 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
258 4ed9f614 2019-08-04 stsp If a path has staged changes, modification status of local changes shown
259 4ed9f614 2019-08-04 stsp in the first output column is relative to the staged changes:
260 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
261 4ed9f614 2019-08-04 stsp .It MM Ta modified file was modified again after being staged
262 4ed9f614 2019-08-04 stsp .It MA Ta added file was modified after being staged
265 97b3a7be 2019-07-09 stsp Short alias for
266 97b3a7be 2019-07-09 stsp .Cm status .
267 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 ]
268 38e11793 2018-06-13 stsp Display history of a repository.
271 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
273 38e11793 2018-06-13 stsp The options for
274 38e11793 2018-06-13 stsp .Cm got log
275 38e11793 2018-06-13 stsp are as follows:
276 38e11793 2018-06-13 stsp .Bl -tag -width Ds
277 38e11793 2018-06-13 stsp .It Fl c Ar commit
278 38e11793 2018-06-13 stsp Start traversing history at the specified
279 38e11793 2018-06-13 stsp .Ar commit .
280 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
281 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
282 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
283 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
284 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
285 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
286 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
287 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
289 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
291 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
292 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
293 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
294 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
295 6238ee32 2018-06-13 stsp .It Fl l Ar N
296 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
298 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
299 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
300 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
301 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
302 04ca23f4 2018-07-16 stsp working directory.
303 e9cf2e30 2019-02-05 stsp If this directory is a
305 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
307 4ed9f614 2019-08-04 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Fl s ] [ Ar object1 Ar object2 | Ar path ]
308 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
309 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
312 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
314 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
315 a54b6686 2019-06-28 stsp or an object ID SHA1 hash, and display differences between these objects.
316 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
317 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
318 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
320 c0cc5c62 2018-10-18 stsp The options for
321 c0cc5c62 2018-10-18 stsp .Cm got diff
322 c0cc5c62 2018-10-18 stsp are as follows:
323 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
324 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
325 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
326 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
327 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
328 b72f483a 2019-02-05 stsp Use the repository at the specified path.
329 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
330 b72f483a 2019-02-05 stsp working directory.
331 b72f483a 2019-02-05 stsp If this directory is a
333 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
335 4ed9f614 2019-08-04 stsp Show changes staged with
336 4ed9f614 2019-08-04 stsp .Cm got stage
337 4ed9f614 2019-08-04 stsp instead of showing local changes.
338 4ed9f614 2019-08-04 stsp This option is only valid when
339 4ed9f614 2019-08-04 stsp .Cm got diff
340 4ed9f614 2019-08-04 stsp is invoked in a work tree.
342 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
343 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
345 1ff8e573 2018-08-02 stsp The options for
346 1ff8e573 2018-08-02 stsp .Cm got blame
347 1ff8e573 2018-08-02 stsp are as follows:
348 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
349 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
350 1ff8e573 2018-08-02 stsp Start traversing history at the specified
351 1ff8e573 2018-08-02 stsp .Ar commit .
352 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
353 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
354 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
355 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
356 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
357 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
358 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
359 1ff8e573 2018-08-02 stsp working directory.
360 0c06baac 2019-02-05 stsp If this directory is a
362 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
364 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
365 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
366 5de5890b 2018-10-18 stsp directory path in the repository.
367 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
368 db0c2996 2019-02-10 stsp annotations:
369 db0c2996 2019-02-10 stsp .Bl -column YXZ description
370 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
371 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
376 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
377 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
378 0c849583 2019-02-05 stsp if there is no work tree.
380 5de5890b 2018-10-18 stsp The options for
381 5de5890b 2018-10-18 stsp .Cm got tree
382 5de5890b 2018-10-18 stsp are as follows:
383 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
384 5de5890b 2018-10-18 stsp .It Fl c Ar commit
385 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
386 5de5890b 2018-10-18 stsp .Ar commit .
387 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
388 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
389 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
390 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
391 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
392 5de5890b 2018-10-18 stsp Use the repository at the specified path.
393 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
394 5de5890b 2018-10-18 stsp working directory.
395 0c849583 2019-02-05 stsp If this directory is a
397 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
399 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
401 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
403 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
404 d0eebce4 2019-03-11 stsp Manage references in a repository.
406 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
407 d0eebce4 2019-03-11 stsp or update, the reference with the given
409 d0eebce4 2019-03-11 stsp and make it point at the given
410 d83d9d5c 2019-05-13 stsp .Ar target .
411 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
412 a54b6686 2019-06-28 stsp will be resolved to an object ID.
413 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
414 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
416 d0eebce4 2019-03-11 stsp The options for
417 d0eebce4 2019-03-11 stsp .Cm got ref
418 d0eebce4 2019-03-11 stsp are as follows:
419 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
420 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
421 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
422 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
423 d0eebce4 2019-03-11 stsp working directory.
424 d0eebce4 2019-03-11 stsp If this directory is a
426 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
428 d0eebce4 2019-03-11 stsp List all existing references in the repository.
429 d0eebce4 2019-03-11 stsp .It Fl d Ar name
430 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
432 4e759de4 2019-06-26 stsp .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
433 4e759de4 2019-06-26 stsp Manage branches in a repository.
435 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
436 4e759de4 2019-06-26 stsp .Dq refs/heads/
437 4e759de4 2019-06-26 stsp reference namespace.
439 4e759de4 2019-06-26 stsp .Cm got branch
440 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
442 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
443 4e759de4 2019-06-26 stsp a branch with the given
445 4e759de4 2019-06-26 stsp and make it point at the given
446 4e759de4 2019-06-26 stsp .Ar base-branch .
448 4e759de4 2019-06-26 stsp .Ar base-branch
449 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
450 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
452 4e759de4 2019-06-26 stsp The options for
453 4e759de4 2019-06-26 stsp .Cm got branch
454 4e759de4 2019-06-26 stsp are as follows:
455 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
456 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
457 4e759de4 2019-06-26 stsp Use the repository at the specified path.
458 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
459 4e759de4 2019-06-26 stsp working directory.
460 4e759de4 2019-06-26 stsp If this directory is a
462 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
464 4e759de4 2019-06-26 stsp List all existing branches in the repository.
465 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
466 ba882ee3 2019-07-11 stsp with one the following annotations:
467 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
468 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
469 ba882ee3 2019-07-11 stsp .It ~ Ta work tree's base commit is out-of-date
471 4e759de4 2019-06-26 stsp .It Fl d Ar name
472 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
473 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
474 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
475 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
476 ce33d90e 2019-07-14 stsp Git's garbage collector.
479 97b3a7be 2019-07-09 stsp Short alias for
480 97b3a7be 2019-07-09 stsp .Cm branch .
481 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
482 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
483 d00136be 2019-03-26 stsp repository in the next commit.
484 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
485 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
486 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
488 2ec1f75b 2019-03-26 stsp The options for
489 86d25a1b 2019-07-11 stsp .Cm got remove
490 2ec1f75b 2019-03-26 stsp are as follows:
491 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
493 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
496 648e4ef7 2019-07-09 stsp Short alias for
497 648e4ef7 2019-07-09 stsp .Cm remove .
498 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
499 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
500 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
501 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
502 a129376b 2019-03-28 stsp changes back after
503 a129376b 2019-03-28 stsp .Cm got revert !
505 e20a8b6f 2019-06-04 stsp If a file was added with
506 a129376b 2019-03-28 stsp .Cm got add
507 a129376b 2019-03-28 stsp it will become an unversioned file again.
508 e20a8b6f 2019-06-04 stsp If a file was deleted with
509 86d25a1b 2019-07-11 stsp .Cm got remove
510 a129376b 2019-03-28 stsp it will be restored.
512 97b3a7be 2019-07-09 stsp Short alias for
513 97b3a7be 2019-07-09 stsp .Cm revert .
514 5c1e53bc 2019-07-28 stsp .It Cm commit [ Fl m Ar message ] [ path ... ]
515 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
516 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
519 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
520 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
522 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
523 4ed9f614 2019-08-04 stsp .Cm got stage,
524 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
525 4ed9f614 2019-08-04 stsp have not been staged.
527 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
528 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
529 15cd91f7 2019-05-12 stsp .It M Ta modified file
530 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
531 15cd91f7 2019-05-12 stsp .It A Ta new file was added
534 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
538 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
539 15cd91f7 2019-05-12 stsp multiple base commits.
540 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
541 47ec7be7 2019-05-12 stsp .Cm got update
542 47ec7be7 2019-05-12 stsp across the entire work tree.
545 15cd91f7 2019-05-12 stsp .Cm got commit
546 15cd91f7 2019-05-12 stsp command requires the
547 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
548 74416c47 2019-05-09 stsp environment variable to be set.
550 74416c47 2019-05-09 stsp The options for
551 74416c47 2019-05-09 stsp .Cm got commit
552 74416c47 2019-05-09 stsp are as follows:
553 74416c47 2019-05-09 stsp .Bl -tag -width Ds
554 74ff3f23 2019-07-07 stsp .It Fl m Ar message
555 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
556 23594da9 2019-05-13 stsp Without the
559 23594da9 2019-05-13 stsp .Cm got commit
560 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
563 cfce0458 2019-07-28 stsp .Cm got commit
564 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
565 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
566 916f288c 2019-07-30 stsp .Dq refs/heads/
567 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
568 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
569 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
570 cfce0458 2019-07-28 stsp If a path is found to be out of date,
571 cfce0458 2019-07-28 stsp .Cm got update
572 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
573 cfce0458 2019-07-28 stsp in the repository.
574 4ed9f614 2019-08-04 stsp If changes have been staged with
575 4ed9f614 2019-08-04 stsp .Cm got stage ,
577 4ed9f614 2019-08-04 stsp .Cm got commit
578 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
580 97b3a7be 2019-07-09 stsp Short alias for
581 97b3a7be 2019-07-09 stsp .Cm commit .
582 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
583 234035bc 2019-06-01 stsp Merge changes from a single
585 234035bc 2019-06-01 stsp into the work tree.
586 234035bc 2019-06-01 stsp The specified
588 234035bc 2019-06-01 stsp must be on a different branch than 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 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
594 234035bc 2019-06-01 stsp .Bl -column YXZ description
595 234035bc 2019-06-01 stsp .It G Ta file was merged
596 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
597 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
598 234035bc 2019-06-01 stsp .It D Ta file was deleted
599 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
600 234035bc 2019-06-01 stsp .It A Ta new file was added
601 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
604 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
605 234035bc 2019-06-01 stsp may be viewed with
606 234035bc 2019-06-01 stsp .Cm got diff ,
607 234035bc 2019-06-01 stsp amended manually or with further
608 234035bc 2019-06-01 stsp .Cm got cherrypick
610 234035bc 2019-06-01 stsp committed with
611 234035bc 2019-06-01 stsp .Cm got commit ,
612 234035bc 2019-06-01 stsp or discarded again with
613 234035bc 2019-06-01 stsp .Cm got revert .
615 234035bc 2019-06-01 stsp .Cm got cherrypick
616 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
617 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
618 234035bc 2019-06-01 stsp to a single base commit with
619 234035bc 2019-06-01 stsp .Cm got update .
620 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
621 234035bc 2019-06-01 stsp conflicts must be resolved first.
623 97b3a7be 2019-07-09 stsp Short alias for
624 97b3a7be 2019-07-09 stsp .Cm cherrypick .
625 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
626 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
628 5ef14e63 2019-06-02 stsp into the work tree.
629 5ef14e63 2019-06-02 stsp The specified
631 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
632 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
633 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
634 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
636 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
637 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
638 5ef14e63 2019-06-02 stsp .It G Ta file was merged
639 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
640 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
641 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
642 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
643 5ef14e63 2019-06-02 stsp .It A Ta new file was added
644 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
647 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
648 5ef14e63 2019-06-02 stsp which may be viewed with
649 5ef14e63 2019-06-02 stsp .Cm got diff ,
650 5ef14e63 2019-06-02 stsp amended manually or with further
651 778a73c2 2019-07-12 stsp .Cm got backout
653 5ef14e63 2019-06-02 stsp committed with
654 5ef14e63 2019-06-02 stsp .Cm got commit ,
655 5ef14e63 2019-06-02 stsp or discarded again with
656 5ef14e63 2019-06-02 stsp .Cm got revert .
658 92228c38 2019-06-02 stsp .Cm got backout
659 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
660 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
661 92228c38 2019-06-02 stsp to a single base commit with
662 92228c38 2019-06-02 stsp .Cm got update .
663 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
664 92228c38 2019-06-02 stsp conflicts must be resolved first.
666 97b3a7be 2019-07-09 stsp Short alias for
667 97b3a7be 2019-07-09 stsp .Cm backout .
668 cd98404f 2019-07-14 stsp .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
669 818c7501 2019-07-11 stsp Rebase commits on the specified
671 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
674 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
675 f09e2405 2019-07-11 stsp Rebasing begins with the first descendent commit of the youngest
676 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
678 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
679 f09e2405 2019-07-11 stsp of the specified
681 f09e2405 2019-07-11 stsp has been rebased.
683 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
684 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
685 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
686 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
687 818c7501 2019-07-11 stsp .Ar branch ,
688 818c7501 2019-07-11 stsp but with different commit IDs.
689 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
690 f09e2405 2019-07-11 stsp the new version of the specified
692 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
694 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
695 818c7501 2019-07-11 stsp using the following status codes:
696 818c7501 2019-07-11 stsp .Bl -column YXZ description
697 818c7501 2019-07-11 stsp .It G Ta file was merged
698 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
699 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
700 818c7501 2019-07-11 stsp .It D Ta file was deleted
701 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
702 818c7501 2019-07-11 stsp .It A Ta new file was added
703 818c7501 2019-07-11 stsp .It ~ Ta changes destined for a non-regular file were not merged
706 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
707 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
708 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
710 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
712 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
713 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
714 f09e2405 2019-07-11 stsp when the rebase operation continues.
716 818c7501 2019-07-11 stsp .Cm got rebase
717 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
718 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
719 818c7501 2019-07-11 stsp to a single base commit with
720 818c7501 2019-07-11 stsp .Cm got update .
721 4ed9f614 2019-08-04 stsp If changes have been staged with
722 4ed9f614 2019-08-04 stsp .Cm got stage ,
723 4ed9f614 2019-08-04 stsp these changes must first be comitted with
724 4ed9f614 2019-08-04 stsp .Cm got commit
725 4ed9f614 2019-08-04 stsp or unstaged with
726 4ed9f614 2019-08-04 stsp .Cm got unstage .
727 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
728 f09e2405 2019-07-11 stsp committed with
729 f09e2405 2019-07-11 stsp .Cm got commit
730 f09e2405 2019-07-11 stsp or reverted with
731 f09e2405 2019-07-11 stsp .Cm got revert .
734 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
735 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
738 7d5807f4 2019-07-11 stsp .Cm got update
740 7d5807f4 2019-07-11 stsp .Cm got commit
741 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
742 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
743 7d5807f4 2019-07-11 stsp conflict resolution purposes.
745 818c7501 2019-07-11 stsp The options for
746 818c7501 2019-07-11 stsp .Cm got rebase
747 818c7501 2019-07-11 stsp are as follows:
748 818c7501 2019-07-11 stsp .Bl -tag -width Ds
750 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
751 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
753 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
754 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
757 818c7501 2019-07-11 stsp Short alias for
758 818c7501 2019-07-11 stsp .Cm rebase .
759 0ebf8283 2019-07-24 stsp .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
760 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
761 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
763 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
764 0ebf8283 2019-07-24 stsp .Ar histedit script
765 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
766 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
767 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
768 0ebf8283 2019-07-24 stsp whitespace and an argument.
769 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
770 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
771 0ebf8283 2019-07-24 stsp Lines which begin with the
773 0ebf8283 2019-07-24 stsp character are ignored entirely.
775 0ebf8283 2019-07-24 stsp The available commands are as follows:
776 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
777 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
778 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
779 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
780 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
781 0ebf8283 2019-07-24 stsp listed further below that will be used.
782 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
783 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
784 0ebf8283 2019-07-24 stsp the commit on the previous line.
785 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
786 0ebf8283 2019-07-24 stsp log message can be written.
789 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
790 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
792 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
793 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
794 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
795 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
796 498a90b7 2019-07-25 stsp switched to it.
798 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
799 0ebf8283 2019-07-24 stsp using the following status codes:
800 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
801 0ebf8283 2019-07-24 stsp .It G Ta file was merged
802 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
803 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
804 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
805 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
806 0ebf8283 2019-07-24 stsp .It A Ta new file was added
807 0ebf8283 2019-07-24 stsp .It ~ Ta changes destined for a non-regular file were not merged
810 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
811 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
812 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
813 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
815 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
816 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
817 0ebf8283 2019-07-24 stsp when the histedit operation continues.
819 0ebf8283 2019-07-24 stsp .Cm got histedit
820 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
821 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
822 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
823 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
824 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
825 0ebf8283 2019-07-24 stsp to a single base commit with
826 0ebf8283 2019-07-24 stsp .Cm got update .
827 4ed9f614 2019-08-04 stsp If changes have been staged with
828 4ed9f614 2019-08-04 stsp .Cm got stage ,
829 4ed9f614 2019-08-04 stsp these changes must first be comitted with
830 4ed9f614 2019-08-04 stsp .Cm got commit
831 4ed9f614 2019-08-04 stsp or unstaged with
832 4ed9f614 2019-08-04 stsp .Cm got unstage .
833 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
834 0ebf8283 2019-07-24 stsp committed with
835 0ebf8283 2019-07-24 stsp .Cm got commit
836 0ebf8283 2019-07-24 stsp or reverted with
837 0ebf8283 2019-07-24 stsp .Cm got revert .
838 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
839 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
842 0ebf8283 2019-07-24 stsp .Cm got update
843 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
844 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
845 0ebf8283 2019-07-24 stsp .Cm got commit
846 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
847 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
849 0ebf8283 2019-07-24 stsp The options for
850 0ebf8283 2019-07-24 stsp .Cm got histedit
851 0ebf8283 2019-07-24 stsp are as follows:
852 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
854 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
855 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
857 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
858 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
861 0ebf8283 2019-07-24 stsp Short alias for
862 0ebf8283 2019-07-24 stsp .Cm histedit .
863 4ed9f614 2019-08-04 stsp .It Cm stage [ Fl l ] Ar file-path ...
864 4ed9f614 2019-08-04 stsp Stage local changes at the specified paths for inclusion in the next commit.
865 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
866 4ed9f614 2019-08-04 stsp .Cm got status .
868 4ed9f614 2019-08-04 stsp Staged changes affect the behaviour of the
869 4ed9f614 2019-08-04 stsp .Cm got commit ,
870 4ed9f614 2019-08-04 stsp .Cm got status ,
872 4ed9f614 2019-08-04 stsp .Cm got diff .
873 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
874 4ed9f614 2019-08-04 stsp .Cm got commit
875 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
876 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
877 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
879 4ed9f614 2019-08-04 stsp .Cm got status
880 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
882 4ed9f614 2019-08-04 stsp .Cm got diff
883 4ed9f614 2019-08-04 stsp is able to display local changes relative to staged changes, and to
884 4ed9f614 2019-08-04 stsp display staged changes relative to the repository.
886 4ed9f614 2019-08-04 stsp .Cm got revert
887 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
888 4ed9f614 2019-08-04 stsp local changes relative to staged changes.
890 4ed9f614 2019-08-04 stsp The options for
891 4ed9f614 2019-08-04 stsp .Cm got stage
892 4ed9f614 2019-08-04 stsp are as follows:
893 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
895 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
896 4ed9f614 2019-08-04 stsp along with the IDs of corresponding blob objects.
897 4ed9f614 2019-08-04 stsp Indicate staged status using the following status codes:
898 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
899 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
900 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
901 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
905 4ed9f614 2019-08-04 stsp .Cm got stage
906 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
907 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
908 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
909 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
910 4ed9f614 2019-08-04 stsp .Cm got update
911 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
912 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
915 4ed9f614 2019-08-04 stsp .Cm got update ,
916 4ed9f614 2019-08-04 stsp .Cm got rebase ,
918 4ed9f614 2019-08-04 stsp .Cm got histedit
919 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
920 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
921 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
922 4ed9f614 2019-08-04 stsp .Cm got unstage
923 4ed9f614 2019-08-04 stsp before it can be updated with
924 4ed9f614 2019-08-04 stsp .Cm got update ,
925 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
927 4ed9f614 2019-08-04 stsp Short alias for
928 4ed9f614 2019-08-04 stsp .Cm stage .
929 4ed9f614 2019-08-04 stsp .It Cm unstage [ Ar path ... ]
930 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
931 4ed9f614 2019-08-04 stsp back into non-staged status.
934 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
936 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
937 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
938 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
939 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
940 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
941 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
942 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
943 4ed9f614 2019-08-04 stsp .It ~ Ta changes destined for a non-regular file were not merged
946 4ed9f614 2019-08-04 stsp Short alias for
947 4ed9f614 2019-08-04 stsp .Cm unstage .
949 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
950 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
951 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
952 74416c47 2019-05-09 stsp The author's name and email address for
953 21a44f98 2019-07-15 stsp .Cm got commit
955 21a44f98 2019-07-15 stsp .Cm got import ,
956 74416c47 2019-05-09 stsp for example:
957 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
958 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
959 23594da9 2019-05-13 stsp The editor spawned by
960 23594da9 2019-05-13 stsp .Cm got commit .
962 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
963 5c860e29 2018-03-12 stsp .Ex -std got
964 97925469 2018-03-17 stsp .Sh EXAMPLES
965 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
967 fa6e0e48 2019-05-23 stsp This step currently requires
968 fa6e0e48 2019-05-23 stsp .Xr git 1 :
970 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
971 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
973 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
975 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
976 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
977 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
979 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
980 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
982 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
984 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
986 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
988 e70c17ce 2019-05-22 stsp .Dl $ got status
989 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
991 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
993 4e759de4 2019-06-26 stsp .Dl $ got branch -l
995 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
996 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
997 d83d9d5c 2019-05-13 stsp which is forked off the
1001 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1003 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1004 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1005 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1007 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1009 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1010 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1012 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1014 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1015 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1016 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1018 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
1020 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1022 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1023 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1025 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1026 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1028 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1030 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1031 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1032 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1034 95fc3404 2019-07-15 stsp .Dl $ got update
1036 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1037 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1038 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1040 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1041 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1042 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1043 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1045 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
1046 9221fb1e 2019-06-26 stsp This step currently requires
1047 9221fb1e 2019-06-26 stsp .Xr git 1 :
1049 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1050 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
1052 fa6e0e48 2019-05-23 stsp Rebase the
1053 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1054 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1055 fa6e0e48 2019-05-23 stsp .Dq master
1058 818c7501 2019-07-11 stsp .Dl $ got update -b master
1059 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1061 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1062 7d7ffedb 2019-07-14 stsp The patch can be mailed out for review and applied to OpenBSD's CVS tree:
1064 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1066 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1067 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1070 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1071 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1072 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1074 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
1075 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1076 7b3fde24 2019-07-28 stsp .Cm git fetch
1078 7b3fde24 2019-07-28 stsp .Cm git push .
1079 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1080 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
1082 ff2cf171 2019-07-28 stsp .Dq refspec
1083 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1085 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1086 ff2cf171 2019-07-28 stsp namespace of the local repository.
1087 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1088 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1089 ff2cf171 2019-07-28 stsp configuration variable to the value
1090 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1092 ff2cf171 2019-07-28 stsp .Cm git config
1095 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1096 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1098 ff2cf171 2019-07-28 stsp Alternatively, the following
1100 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1101 ff2cf171 2019-07-28 stsp .Pa config
1104 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1105 ff2cf171 2019-07-28 stsp .Dl url = ...
1106 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1108 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1109 ff2cf171 2019-07-28 stsp .Dq refs/heads
1110 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1111 ff2cf171 2019-07-28 stsp .Cm got checkout
1112 ff2cf171 2019-07-28 stsp and, if needed, created with
1113 ff2cf171 2019-07-28 stsp .Cm got branch .
1115 ff2cf171 2019-07-28 stsp Branches in the
1116 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1117 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
1118 ff2cf171 2019-07-28 stsp repository with
1119 ff2cf171 2019-07-28 stsp .Cm git fetch :
1121 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1122 ff2cf171 2019-07-28 stsp .Dl $ git fetch
1124 ff2cf171 2019-07-28 stsp Before outgoing changes on the local
1125 ff2cf171 2019-07-28 stsp .Dq master
1126 ff2cf171 2019-07-28 stsp branch can be pushed to the remote repository, the local
1127 ff2cf171 2019-07-28 stsp .Dq master
1128 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1129 ff2cf171 2019-07-28 stsp .Dq origin/master
1132 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1133 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1135 ff2cf171 2019-07-28 stsp Changes on the local
1136 ff2cf171 2019-07-28 stsp .Dq master
1137 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1138 ff2cf171 2019-07-28 stsp repository with
1139 ff2cf171 2019-07-28 stsp .Cm git push :
1141 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1142 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1144 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1145 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1146 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1147 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1148 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1149 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1150 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1151 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
1152 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1154 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1155 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1157 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1158 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
