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 8e13c46f 2019-08-05 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 fef8a0d3 2019-08-04 stsp Display usage information and exit immediately.
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.
78 bc26cce8 2019-08-04 stsp Short alias for
80 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
81 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
82 3ce1b845 2019-07-15 stsp within the specified
83 3ce1b845 2019-07-15 stsp .Ar directory .
84 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
85 3ce1b845 2019-07-15 stsp root commit.
86 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
87 3ce1b845 2019-07-15 stsp created commit.
88 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
91 21a44f98 2019-07-15 stsp .Cm got import
92 21a44f98 2019-07-15 stsp command requires the
93 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
94 21a44f98 2019-07-15 stsp environment variable to be set.
96 3ce1b845 2019-07-15 stsp The options for
97 3ce1b845 2019-07-15 stsp .Cm got import
98 3ce1b845 2019-07-15 stsp are as follows:
99 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
100 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
101 3ce1b845 2019-07-15 stsp Create the specified
103 3ce1b845 2019-07-15 stsp instead of creating the default branch
104 3ce1b845 2019-07-15 stsp .Dq master .
105 3ce1b845 2019-07-15 stsp Use of this option is required if the
107 3ce1b845 2019-07-15 stsp branch already exists.
108 3ce1b845 2019-07-15 stsp .It Fl m Ar message
109 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
110 3ce1b845 2019-07-15 stsp Without the
113 3ce1b845 2019-07-15 stsp .Cm got import
114 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
115 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
116 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
117 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
118 3ce1b845 2019-07-15 stsp working directory.
119 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
120 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
121 3ce1b845 2019-07-15 stsp .Ar pattern .
122 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
124 3ce1b845 2019-07-15 stsp .Ar pattern
125 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
126 3ce1b845 2019-07-15 stsp .Xr glob 7 .
129 bc26cce8 2019-08-04 stsp Short alias for
130 bc26cce8 2019-08-04 stsp .Cm import .
131 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 ]
132 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
134 5d7c1dab 2018-04-01 stsp .Ar work tree path
135 c844a238 2019-02-06 stsp is not specified, either use the last component of
136 5d7c1dab 2018-04-01 stsp .Ar repository path ,
138 5d7c1dab 2018-04-01 stsp .Ar path prefix
139 c844a238 2019-02-06 stsp was specified use the last component of
140 5d7c1dab 2018-04-01 stsp .Ar path prefix .
142 38e11793 2018-06-13 stsp The options for
143 38e11793 2018-06-13 stsp .Cm got checkout
144 38e11793 2018-06-13 stsp are as follows:
145 38e11793 2018-06-13 stsp .Bl -tag -width Ds
146 08573d5b 2019-05-14 stsp .It Fl b Ar branch
147 3c575567 2019-07-28 stsp Check out files from a commit on the specified
148 08573d5b 2019-05-14 stsp .Ar branch .
149 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
150 08573d5b 2019-05-14 stsp reference will be used.
151 8069f636 2019-01-12 stsp .It Fl c Ar commit
152 8069f636 2019-01-12 stsp Check out files from the specified
154 3c575567 2019-07-28 stsp on the selected branch.
155 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
156 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
157 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
158 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
159 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
160 08573d5b 2019-05-14 stsp branch will be used.
161 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
162 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
163 38e11793 2018-06-13 stsp Only files beneath the specified
164 38e11793 2018-06-13 stsp .Ar path-prefix
165 38e11793 2018-06-13 stsp will be checked out.
168 97b3a7be 2019-07-09 stsp Short alias for
169 97b3a7be 2019-07-09 stsp .Cm checkout .
170 f2ea84fa 2019-07-27 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ... ]
171 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
172 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
173 7f838b36 2019-02-08 stsp .Bl -column YXZ description
174 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
175 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
176 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
177 7f838b36 2019-02-08 stsp .It D Ta file was deleted
178 7f838b36 2019-02-08 stsp .It A Ta new file was added
179 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
180 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
185 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
186 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
187 f2ea84fa 2019-07-27 stsp specified paths.
188 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
189 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
190 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
193 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
194 c4cdcb68 2019-04-03 stsp multiple base commits.
195 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
196 47ec7be7 2019-05-12 stsp .Cm got update
197 47ec7be7 2019-05-12 stsp across the entire work tree.
198 024e9686 2019-05-14 stsp Specifying a
200 024e9686 2019-05-14 stsp is incompatible with the
204 4ed9f614 2019-08-04 stsp .Cm got update
205 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
206 4ed9f614 2019-08-04 stsp If changes have been staged with
207 4ed9f614 2019-08-04 stsp .Cm got stage ,
208 4ed9f614 2019-08-04 stsp these changes must first be comitted with
209 4ed9f614 2019-08-04 stsp .Cm got commit
210 4ed9f614 2019-08-04 stsp or unstaged with
211 4ed9f614 2019-08-04 stsp .Cm got unstage .
213 507dc3bb 2018-12-29 stsp The options for
214 507dc3bb 2018-12-29 stsp .Cm got update
215 507dc3bb 2018-12-29 stsp are as follows:
216 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
217 024e9686 2019-05-14 stsp .It Fl b Ar branch
218 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
220 024e9686 2019-05-14 stsp before updating the work tree.
221 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
222 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
223 507dc3bb 2018-12-29 stsp Update the work tree to the specified
224 507dc3bb 2018-12-29 stsp .Ar commit .
225 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
226 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
227 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
228 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
229 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
230 024e9686 2019-05-14 stsp branch will be used.
233 97b3a7be 2019-07-09 stsp Short alias for
234 97b3a7be 2019-07-09 stsp .Cm update .
235 72ea6654 2019-07-27 stsp .It Cm status [ Ar path ... ]
236 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
237 6bad629b 2019-02-04 stsp using the following status codes:
238 6bad629b 2019-02-04 stsp .Bl -column YXZ description
239 6bad629b 2019-02-04 stsp .It M Ta modified file
240 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
241 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
242 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
243 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
244 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
245 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
251 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
252 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
254 4ed9f614 2019-08-04 stsp If changes have been staged with
255 4ed9f614 2019-08-04 stsp .Cm got stage ,
256 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
257 4ed9f614 2019-08-04 stsp status codes:
258 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
259 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
260 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
261 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
264 6dc1d418 2019-08-04 stsp If a path has staged changes, modification status of files shown
265 4ed9f614 2019-08-04 stsp in the first output column is relative to the staged changes:
266 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
267 4ed9f614 2019-08-04 stsp .It MM Ta modified file was modified again after being staged
268 4ed9f614 2019-08-04 stsp .It MA Ta added file was modified after being staged
271 97b3a7be 2019-07-09 stsp Short alias for
272 97b3a7be 2019-07-09 stsp .Cm status .
273 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 ]
274 38e11793 2018-06-13 stsp Display history of a repository.
277 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
279 38e11793 2018-06-13 stsp The options for
280 38e11793 2018-06-13 stsp .Cm got log
281 38e11793 2018-06-13 stsp are as follows:
282 38e11793 2018-06-13 stsp .Bl -tag -width Ds
283 38e11793 2018-06-13 stsp .It Fl c Ar commit
284 38e11793 2018-06-13 stsp Start traversing history at the specified
285 38e11793 2018-06-13 stsp .Ar commit .
286 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
287 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
288 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
289 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
290 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
291 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
292 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
293 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
295 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
297 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
298 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
299 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
300 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
301 6238ee32 2018-06-13 stsp .It Fl l Ar N
302 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
304 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
305 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
306 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
307 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
308 04ca23f4 2018-07-16 stsp working directory.
309 e9cf2e30 2019-02-05 stsp If this directory is a
311 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
313 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 ]
314 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
315 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
318 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
320 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
321 a54b6686 2019-06-28 stsp or an object ID SHA1 hash, and display differences between these objects.
322 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
323 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
324 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
326 c0cc5c62 2018-10-18 stsp The options for
327 c0cc5c62 2018-10-18 stsp .Cm got diff
328 c0cc5c62 2018-10-18 stsp are as follows:
329 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
330 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
331 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
332 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
333 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
334 b72f483a 2019-02-05 stsp Use the repository at the specified path.
335 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
336 b72f483a 2019-02-05 stsp working directory.
337 b72f483a 2019-02-05 stsp If this directory is a
339 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
341 4ed9f614 2019-08-04 stsp Show changes staged with
342 4ed9f614 2019-08-04 stsp .Cm got stage
343 4ed9f614 2019-08-04 stsp instead of showing local changes.
344 4ed9f614 2019-08-04 stsp This option is only valid when
345 4ed9f614 2019-08-04 stsp .Cm got diff
346 4ed9f614 2019-08-04 stsp is invoked in a work tree.
349 bc26cce8 2019-08-04 stsp Short alias for
351 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
352 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
354 1ff8e573 2018-08-02 stsp The options for
355 1ff8e573 2018-08-02 stsp .Cm got blame
356 1ff8e573 2018-08-02 stsp are as follows:
357 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
358 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
359 1ff8e573 2018-08-02 stsp Start traversing history at the specified
360 1ff8e573 2018-08-02 stsp .Ar commit .
361 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
362 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
363 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
364 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
365 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
366 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
367 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
368 1ff8e573 2018-08-02 stsp working directory.
369 0c06baac 2019-02-05 stsp If this directory is a
371 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
374 bc26cce8 2019-08-04 stsp Short alias for
375 bc26cce8 2019-08-04 stsp .Cm blame .
376 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
377 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
378 5de5890b 2018-10-18 stsp directory path in the repository.
379 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
380 db0c2996 2019-02-10 stsp annotations:
381 db0c2996 2019-02-10 stsp .Bl -column YXZ description
382 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
383 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
388 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
389 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
390 0c849583 2019-02-05 stsp if there is no work tree.
392 5de5890b 2018-10-18 stsp The options for
393 5de5890b 2018-10-18 stsp .Cm got tree
394 5de5890b 2018-10-18 stsp are as follows:
395 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
396 5de5890b 2018-10-18 stsp .It Fl c Ar commit
397 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
398 5de5890b 2018-10-18 stsp .Ar commit .
399 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
400 30837e32 2019-07-25 stsp which will be resolved to a commit ID.
401 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
402 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
403 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
404 5de5890b 2018-10-18 stsp Use the repository at the specified path.
405 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
406 5de5890b 2018-10-18 stsp working directory.
407 0c849583 2019-02-05 stsp If this directory is a
409 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
411 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
413 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
416 bc26cce8 2019-08-04 stsp Short alias for
418 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
419 d0eebce4 2019-03-11 stsp Manage references in a repository.
421 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
422 d0eebce4 2019-03-11 stsp or update, the reference with the given
424 d0eebce4 2019-03-11 stsp and make it point at the given
425 d83d9d5c 2019-05-13 stsp .Ar target .
426 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
427 a54b6686 2019-06-28 stsp will be resolved to an object ID.
428 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
429 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
431 d0eebce4 2019-03-11 stsp The options for
432 d0eebce4 2019-03-11 stsp .Cm got ref
433 d0eebce4 2019-03-11 stsp are as follows:
434 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
435 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
436 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
437 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
438 d0eebce4 2019-03-11 stsp working directory.
439 d0eebce4 2019-03-11 stsp If this directory is a
441 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
443 d0eebce4 2019-03-11 stsp List all existing references in the repository.
444 d0eebce4 2019-03-11 stsp .It Fl d Ar name
445 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
447 4e759de4 2019-06-26 stsp .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
448 4e759de4 2019-06-26 stsp Manage branches in a repository.
450 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
451 4e759de4 2019-06-26 stsp .Dq refs/heads/
452 4e759de4 2019-06-26 stsp reference namespace.
454 4e759de4 2019-06-26 stsp .Cm got branch
455 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
457 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
458 4e759de4 2019-06-26 stsp a branch with the given
460 4e759de4 2019-06-26 stsp and make it point at the given
461 4e759de4 2019-06-26 stsp .Ar base-branch .
463 4e759de4 2019-06-26 stsp .Ar base-branch
464 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
465 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
467 4e759de4 2019-06-26 stsp The options for
468 4e759de4 2019-06-26 stsp .Cm got branch
469 4e759de4 2019-06-26 stsp are as follows:
470 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
471 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
472 4e759de4 2019-06-26 stsp Use the repository at the specified path.
473 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
474 4e759de4 2019-06-26 stsp working directory.
475 4e759de4 2019-06-26 stsp If this directory is a
477 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
479 4e759de4 2019-06-26 stsp List all existing branches in the repository.
480 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
481 ba882ee3 2019-07-11 stsp with one the following annotations:
482 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
483 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
484 ba882ee3 2019-07-11 stsp .It ~ Ta work tree's base commit is out-of-date
486 4e759de4 2019-06-26 stsp .It Fl d Ar name
487 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
488 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
489 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
490 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
491 ce33d90e 2019-07-14 stsp Git's garbage collector.
494 97b3a7be 2019-07-09 stsp Short alias for
495 97b3a7be 2019-07-09 stsp .Cm branch .
496 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
497 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
498 d00136be 2019-03-26 stsp repository in the next commit.
499 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
500 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
501 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
503 2ec1f75b 2019-03-26 stsp The options for
504 86d25a1b 2019-07-11 stsp .Cm got remove
505 2ec1f75b 2019-03-26 stsp are as follows:
506 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
508 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
511 648e4ef7 2019-07-09 stsp Short alias for
512 648e4ef7 2019-07-09 stsp .Cm remove .
513 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
514 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
515 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
516 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
517 a129376b 2019-03-28 stsp changes back after
518 a129376b 2019-03-28 stsp .Cm got revert !
520 e20a8b6f 2019-06-04 stsp If a file was added with
521 a129376b 2019-03-28 stsp .Cm got add
522 a129376b 2019-03-28 stsp it will become an unversioned file again.
523 e20a8b6f 2019-06-04 stsp If a file was deleted with
524 86d25a1b 2019-07-11 stsp .Cm got remove
525 a129376b 2019-03-28 stsp it will be restored.
527 97b3a7be 2019-07-09 stsp Short alias for
528 97b3a7be 2019-07-09 stsp .Cm revert .
529 5c1e53bc 2019-07-28 stsp .It Cm commit [ Fl m Ar message ] [ path ... ]
530 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
531 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
534 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
535 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
537 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
538 4ed9f614 2019-08-04 stsp .Cm got stage,
539 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
540 4ed9f614 2019-08-04 stsp have not been staged.
542 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
543 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
544 15cd91f7 2019-05-12 stsp .It M Ta modified file
545 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
546 15cd91f7 2019-05-12 stsp .It A Ta new file was added
549 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
550 996d5ccd 2019-08-05 stsp recorded base commit.
553 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
554 15cd91f7 2019-05-12 stsp multiple base commits.
555 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
556 47ec7be7 2019-05-12 stsp .Cm got update
557 47ec7be7 2019-05-12 stsp across the entire work tree.
560 15cd91f7 2019-05-12 stsp .Cm got commit
561 15cd91f7 2019-05-12 stsp command requires the
562 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
563 74416c47 2019-05-09 stsp environment variable to be set.
565 74416c47 2019-05-09 stsp The options for
566 74416c47 2019-05-09 stsp .Cm got commit
567 74416c47 2019-05-09 stsp are as follows:
568 74416c47 2019-05-09 stsp .Bl -tag -width Ds
569 74ff3f23 2019-07-07 stsp .It Fl m Ar message
570 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
571 23594da9 2019-05-13 stsp Without the
574 23594da9 2019-05-13 stsp .Cm got commit
575 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
578 cfce0458 2019-07-28 stsp .Cm got commit
579 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
580 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
581 916f288c 2019-07-30 stsp .Dq refs/heads/
582 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
583 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
584 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
585 cfce0458 2019-07-28 stsp If a path is found to be out of date,
586 cfce0458 2019-07-28 stsp .Cm got update
587 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
588 cfce0458 2019-07-28 stsp in the repository.
590 97b3a7be 2019-07-09 stsp Short alias for
591 97b3a7be 2019-07-09 stsp .Cm commit .
592 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
593 234035bc 2019-06-01 stsp Merge changes from a single
595 234035bc 2019-06-01 stsp into the work tree.
596 234035bc 2019-06-01 stsp The specified
598 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
599 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
600 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
601 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
603 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
604 234035bc 2019-06-01 stsp .Bl -column YXZ description
605 234035bc 2019-06-01 stsp .It G Ta file was merged
606 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
607 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
608 234035bc 2019-06-01 stsp .It D Ta file was deleted
609 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
610 234035bc 2019-06-01 stsp .It A Ta new file was added
611 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
614 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
615 234035bc 2019-06-01 stsp may be viewed with
616 234035bc 2019-06-01 stsp .Cm got diff ,
617 234035bc 2019-06-01 stsp amended manually or with further
618 234035bc 2019-06-01 stsp .Cm got cherrypick
620 234035bc 2019-06-01 stsp committed with
621 234035bc 2019-06-01 stsp .Cm got commit ,
622 234035bc 2019-06-01 stsp or discarded again with
623 234035bc 2019-06-01 stsp .Cm got revert .
625 234035bc 2019-06-01 stsp .Cm got cherrypick
626 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
627 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
628 234035bc 2019-06-01 stsp to a single base commit with
629 234035bc 2019-06-01 stsp .Cm got update .
630 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
631 234035bc 2019-06-01 stsp conflicts must be resolved first.
633 97b3a7be 2019-07-09 stsp Short alias for
634 97b3a7be 2019-07-09 stsp .Cm cherrypick .
635 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
636 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
638 5ef14e63 2019-06-02 stsp into the work tree.
639 5ef14e63 2019-06-02 stsp The specified
641 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
642 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
643 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
644 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
646 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
647 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
648 5ef14e63 2019-06-02 stsp .It G Ta file was merged
649 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
650 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
651 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
652 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
653 5ef14e63 2019-06-02 stsp .It A Ta new file was added
654 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
657 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
658 5ef14e63 2019-06-02 stsp which may be viewed with
659 5ef14e63 2019-06-02 stsp .Cm got diff ,
660 5ef14e63 2019-06-02 stsp amended manually or with further
661 778a73c2 2019-07-12 stsp .Cm got backout
663 5ef14e63 2019-06-02 stsp committed with
664 5ef14e63 2019-06-02 stsp .Cm got commit ,
665 5ef14e63 2019-06-02 stsp or discarded again with
666 5ef14e63 2019-06-02 stsp .Cm got revert .
668 92228c38 2019-06-02 stsp .Cm got backout
669 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
670 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
671 92228c38 2019-06-02 stsp to a single base commit with
672 92228c38 2019-06-02 stsp .Cm got update .
673 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
674 92228c38 2019-06-02 stsp conflicts must be resolved first.
676 97b3a7be 2019-07-09 stsp Short alias for
677 97b3a7be 2019-07-09 stsp .Cm backout .
678 cd98404f 2019-07-14 stsp .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
679 818c7501 2019-07-11 stsp Rebase commits on the specified
681 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
684 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
685 f09e2405 2019-07-11 stsp Rebasing begins with the first descendent commit of the youngest
686 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
688 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
689 f09e2405 2019-07-11 stsp of the specified
691 f09e2405 2019-07-11 stsp has been rebased.
693 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
694 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
695 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
696 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
697 818c7501 2019-07-11 stsp .Ar branch ,
698 818c7501 2019-07-11 stsp but with different commit IDs.
699 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
700 f09e2405 2019-07-11 stsp the new version of the specified
702 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
704 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
705 818c7501 2019-07-11 stsp using the following status codes:
706 818c7501 2019-07-11 stsp .Bl -column YXZ description
707 818c7501 2019-07-11 stsp .It G Ta file was merged
708 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
709 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
710 818c7501 2019-07-11 stsp .It D Ta file was deleted
711 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
712 818c7501 2019-07-11 stsp .It A Ta new file was added
713 818c7501 2019-07-11 stsp .It ~ Ta changes destined for a non-regular file were not merged
716 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
717 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
718 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
720 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
722 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
723 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
724 f09e2405 2019-07-11 stsp when the rebase operation continues.
726 818c7501 2019-07-11 stsp .Cm got rebase
727 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
728 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
729 818c7501 2019-07-11 stsp to a single base commit with
730 818c7501 2019-07-11 stsp .Cm got update .
731 4ed9f614 2019-08-04 stsp If changes have been staged with
732 4ed9f614 2019-08-04 stsp .Cm got stage ,
733 4ed9f614 2019-08-04 stsp these changes must first be comitted with
734 4ed9f614 2019-08-04 stsp .Cm got commit
735 4ed9f614 2019-08-04 stsp or unstaged with
736 4ed9f614 2019-08-04 stsp .Cm got unstage .
737 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
738 f09e2405 2019-07-11 stsp committed with
739 f09e2405 2019-07-11 stsp .Cm got commit
740 f09e2405 2019-07-11 stsp or reverted with
741 f09e2405 2019-07-11 stsp .Cm got revert .
744 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
745 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
748 7d5807f4 2019-07-11 stsp .Cm got update
750 7d5807f4 2019-07-11 stsp .Cm got commit
751 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
752 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
753 7d5807f4 2019-07-11 stsp conflict resolution purposes.
755 818c7501 2019-07-11 stsp The options for
756 818c7501 2019-07-11 stsp .Cm got rebase
757 818c7501 2019-07-11 stsp are as follows:
758 818c7501 2019-07-11 stsp .Bl -tag -width Ds
760 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
761 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
763 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
764 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
767 818c7501 2019-07-11 stsp Short alias for
768 818c7501 2019-07-11 stsp .Cm rebase .
769 0ebf8283 2019-07-24 stsp .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
770 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
771 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
773 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
774 0ebf8283 2019-07-24 stsp .Ar histedit script
775 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
776 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
777 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
778 0ebf8283 2019-07-24 stsp whitespace and an argument.
779 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
780 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
781 0ebf8283 2019-07-24 stsp Lines which begin with the
783 0ebf8283 2019-07-24 stsp character are ignored entirely.
785 0ebf8283 2019-07-24 stsp The available commands are as follows:
786 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
787 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
788 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
789 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
790 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
791 0ebf8283 2019-07-24 stsp listed further below that will be used.
792 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
793 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
794 0ebf8283 2019-07-24 stsp the commit on the previous line.
795 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
796 0ebf8283 2019-07-24 stsp log message can be written.
799 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
800 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
802 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
803 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
804 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
805 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
806 498a90b7 2019-07-25 stsp switched to it.
808 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
809 0ebf8283 2019-07-24 stsp using the following status codes:
810 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
811 0ebf8283 2019-07-24 stsp .It G Ta file was merged
812 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
813 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
814 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
815 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
816 0ebf8283 2019-07-24 stsp .It A Ta new file was added
817 0ebf8283 2019-07-24 stsp .It ~ Ta changes destined for a non-regular file were not merged
820 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
821 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
822 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
823 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
825 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
826 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
827 0ebf8283 2019-07-24 stsp when the histedit operation continues.
829 0ebf8283 2019-07-24 stsp .Cm got histedit
830 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
831 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
832 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
833 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
834 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
835 0ebf8283 2019-07-24 stsp to a single base commit with
836 0ebf8283 2019-07-24 stsp .Cm got update .
837 4ed9f614 2019-08-04 stsp If changes have been staged with
838 4ed9f614 2019-08-04 stsp .Cm got stage ,
839 4ed9f614 2019-08-04 stsp these changes must first be comitted with
840 4ed9f614 2019-08-04 stsp .Cm got commit
841 4ed9f614 2019-08-04 stsp or unstaged with
842 4ed9f614 2019-08-04 stsp .Cm got unstage .
843 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
844 0ebf8283 2019-07-24 stsp committed with
845 0ebf8283 2019-07-24 stsp .Cm got commit
846 0ebf8283 2019-07-24 stsp or reverted with
847 0ebf8283 2019-07-24 stsp .Cm got revert .
848 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
849 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
852 0ebf8283 2019-07-24 stsp .Cm got update
853 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
854 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
855 0ebf8283 2019-07-24 stsp .Cm got commit
856 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
857 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
859 0ebf8283 2019-07-24 stsp The options for
860 0ebf8283 2019-07-24 stsp .Cm got histedit
861 0ebf8283 2019-07-24 stsp are as follows:
862 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
864 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
865 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
867 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
868 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
871 0ebf8283 2019-07-24 stsp Short alias for
872 0ebf8283 2019-07-24 stsp .Cm histedit .
873 3a070a2b 2019-08-07 stsp .It Cm stage [ Fl l ] [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
874 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
877 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
878 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
879 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
880 4ed9f614 2019-08-04 stsp .Cm got status .
882 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
883 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
884 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
885 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
886 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
889 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
890 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
893 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
894 4ed9f614 2019-08-04 stsp .Cm got commit ,
895 4ed9f614 2019-08-04 stsp .Cm got status ,
897 4ed9f614 2019-08-04 stsp .Cm got diff .
898 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
899 4ed9f614 2019-08-04 stsp .Cm got commit
900 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
901 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
902 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
904 4ed9f614 2019-08-04 stsp .Cm got status
905 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
907 4ed9f614 2019-08-04 stsp .Cm got diff
908 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
909 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
911 4ed9f614 2019-08-04 stsp .Cm got revert
912 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
913 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
915 4ed9f614 2019-08-04 stsp The options for
916 4ed9f614 2019-08-04 stsp .Cm got stage
917 4ed9f614 2019-08-04 stsp are as follows:
918 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
920 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
921 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
922 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
923 9d8b19a4 2019-08-04 stsp among the specified paths. Otherwise, show all staged paths.
925 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
926 dc424a06 2019-08-07 stsp select or reject changes for staging based on
928 6d23ec10 2019-08-08 stsp (stage change),
930 6d23ec10 2019-08-08 stsp (reject change), and
932 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
933 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
934 dc424a06 2019-08-07 stsp modified file content can be staged.
935 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
936 6d23ec10 2019-08-08 stsp their entirety.
937 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
940 3a070a2b 2019-08-07 stsp option, read
945 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
946 0e2f5884 2019-08-07 stsp .Ar response-script
947 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
950 4ed9f614 2019-08-04 stsp .Cm got stage
951 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
952 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
953 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
954 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
955 4ed9f614 2019-08-04 stsp .Cm got update
956 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
957 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
960 4ed9f614 2019-08-04 stsp .Cm got update ,
961 4ed9f614 2019-08-04 stsp .Cm got rebase ,
963 4ed9f614 2019-08-04 stsp .Cm got histedit
964 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
965 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
966 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
967 4ed9f614 2019-08-04 stsp .Cm got unstage
968 4ed9f614 2019-08-04 stsp before it can be updated with
969 4ed9f614 2019-08-04 stsp .Cm got update ,
970 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
972 4ed9f614 2019-08-04 stsp Short alias for
973 4ed9f614 2019-08-04 stsp .Cm stage .
974 2e1f37b0 2019-08-08 stsp .It Cm unstage [ Fl p ] [ Fl F Ar response-script ] [ Ar path ... ]
975 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
976 4ed9f614 2019-08-04 stsp back into non-staged status.
979 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
980 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
982 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
983 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
984 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
985 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
986 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
987 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
988 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
989 4ed9f614 2019-08-04 stsp .It ~ Ta changes destined for a non-regular file were not merged
992 2e1f37b0 2019-08-08 stsp The options for
993 2e1f37b0 2019-08-08 stsp .Cm got unstage
994 2e1f37b0 2019-08-08 stsp are as follows:
995 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
997 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
998 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1000 2e1f37b0 2019-08-08 stsp (unstage change),
1002 2e1f37b0 2019-08-08 stsp (keep change staged), and
1004 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1005 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1006 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1007 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1008 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1011 2e1f37b0 2019-08-08 stsp option, read
1016 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1017 2e1f37b0 2019-08-08 stsp .Ar response-script
1018 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1021 4ed9f614 2019-08-04 stsp Short alias for
1022 4ed9f614 2019-08-04 stsp .Cm unstage .
1024 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1025 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1026 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1027 74416c47 2019-05-09 stsp The author's name and email address for
1028 21a44f98 2019-07-15 stsp .Cm got commit
1030 21a44f98 2019-07-15 stsp .Cm got import ,
1031 74416c47 2019-05-09 stsp for example:
1032 4969d6d8 2019-08-06 stsp .An Flan Hacker Aq Mt flan_hacker@openbsd.org
1033 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
1034 23594da9 2019-05-13 stsp The editor spawned by
1035 23594da9 2019-05-13 stsp .Cm got commit .
1037 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1038 5c860e29 2018-03-12 stsp .Ex -std got
1039 97925469 2018-03-17 stsp .Sh EXAMPLES
1040 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1042 fa6e0e48 2019-05-23 stsp This step currently requires
1043 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1045 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1046 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1048 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1050 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1051 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1052 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1054 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1055 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1057 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1059 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1061 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1063 e70c17ce 2019-05-22 stsp .Dl $ got status
1064 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1066 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1068 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1070 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1071 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1072 d83d9d5c 2019-05-13 stsp which is forked off the
1073 d83d9d5c 2019-05-13 stsp .Dq master
1076 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1078 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1079 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1080 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1082 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1084 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1085 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1087 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1089 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1090 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1091 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1093 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
1095 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1097 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1098 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1100 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1101 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1103 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1105 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1106 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1107 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1109 95fc3404 2019-07-15 stsp .Dl $ got update
1111 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1112 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1113 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1115 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1116 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1117 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1118 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1120 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
1121 9221fb1e 2019-06-26 stsp This step currently requires
1122 9221fb1e 2019-06-26 stsp .Xr git 1 :
1124 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1125 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
1127 fa6e0e48 2019-05-23 stsp Rebase the
1128 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1129 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1130 fa6e0e48 2019-05-23 stsp .Dq master
1133 818c7501 2019-07-11 stsp .Dl $ got update -b master
1134 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1136 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1137 7d7ffedb 2019-07-14 stsp The patch can be mailed out for review and applied to OpenBSD's CVS tree:
1139 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1141 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1142 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1145 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1146 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1147 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1149 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
1150 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1151 7b3fde24 2019-07-28 stsp .Cm git fetch
1153 7b3fde24 2019-07-28 stsp .Cm git push .
1154 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1155 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
1157 ff2cf171 2019-07-28 stsp .Dq refspec
1158 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1160 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1161 ff2cf171 2019-07-28 stsp namespace of the local repository.
1162 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1163 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1164 ff2cf171 2019-07-28 stsp configuration variable to the value
1165 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1167 ff2cf171 2019-07-28 stsp .Cm git config
1170 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1171 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1173 ff2cf171 2019-07-28 stsp Alternatively, the following
1175 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1176 ff2cf171 2019-07-28 stsp .Pa config
1179 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1180 ff2cf171 2019-07-28 stsp .Dl url = ...
1181 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1183 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1184 ff2cf171 2019-07-28 stsp .Dq refs/heads
1185 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1186 ff2cf171 2019-07-28 stsp .Cm got checkout
1187 ff2cf171 2019-07-28 stsp and, if needed, created with
1188 ff2cf171 2019-07-28 stsp .Cm got branch .
1190 ff2cf171 2019-07-28 stsp Branches in the
1191 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1192 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
1193 ff2cf171 2019-07-28 stsp repository with
1194 ff2cf171 2019-07-28 stsp .Cm git fetch :
1196 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1197 ff2cf171 2019-07-28 stsp .Dl $ git fetch
1199 ff2cf171 2019-07-28 stsp Before outgoing changes on the local
1200 ff2cf171 2019-07-28 stsp .Dq master
1201 ff2cf171 2019-07-28 stsp branch can be pushed to the remote repository, the local
1202 ff2cf171 2019-07-28 stsp .Dq master
1203 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1204 ff2cf171 2019-07-28 stsp .Dq origin/master
1207 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1208 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1210 ff2cf171 2019-07-28 stsp Changes on the local
1211 ff2cf171 2019-07-28 stsp .Dq master
1212 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1213 ff2cf171 2019-07-28 stsp repository with
1214 ff2cf171 2019-07-28 stsp .Cm git push :
1216 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1217 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1219 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1220 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1221 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1222 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1223 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1224 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1225 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1226 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
1227 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1229 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1230 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1232 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1233 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
