2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5aa81393 2020-01-06 stsp .\" Copyright (c) 2018, 2019, 2020 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 bc3056e3 2019-08-18 stsp Global options must precede 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.
57 83cd27f8 2020-01-13 stsp .It Fl V, -version
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 bc26cce8 2019-08-04 stsp Short alias for
79 dfc23429 2019-08-11 stsp .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
80 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
81 3ce1b845 2019-07-15 stsp within the specified
82 3ce1b845 2019-07-15 stsp .Ar directory .
83 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
84 3ce1b845 2019-07-15 stsp root commit.
85 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
86 3ce1b845 2019-07-15 stsp created commit.
87 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
90 21a44f98 2019-07-15 stsp .Cm got import
91 21a44f98 2019-07-15 stsp command requires the
92 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
93 aba9c984 2019-09-08 stsp environment variable to be set,
94 aba9c984 2019-09-08 stsp unless Git's
95 aba9c984 2019-09-08 stsp .Dv user.name
97 709ae9eb 2019-09-08 stsp .Dv user.email
98 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
99 aba9c984 2019-09-08 stsp .Pa .git/config
100 c9956ddf 2019-09-08 stsp file or from Git's global
101 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
102 c9956ddf 2019-09-08 stsp configuration file.
104 3ce1b845 2019-07-15 stsp The options for
105 3ce1b845 2019-07-15 stsp .Cm got import
106 3ce1b845 2019-07-15 stsp are as follows:
107 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
108 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
109 3ce1b845 2019-07-15 stsp Create the specified
111 3ce1b845 2019-07-15 stsp instead of creating the default branch
113 3ce1b845 2019-07-15 stsp Use of this option is required if the
115 3ce1b845 2019-07-15 stsp branch already exists.
116 3ce1b845 2019-07-15 stsp .It Fl m Ar message
117 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
118 3ce1b845 2019-07-15 stsp Without the
121 3ce1b845 2019-07-15 stsp .Cm got import
122 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
123 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
124 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
125 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
126 3ce1b845 2019-07-15 stsp working directory.
127 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
128 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
129 3ce1b845 2019-07-15 stsp .Ar pattern .
130 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
132 3ce1b845 2019-07-15 stsp .Ar pattern
133 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
134 3ce1b845 2019-07-15 stsp .Xr glob 7 .
137 bc26cce8 2019-08-04 stsp Short alias for
138 bc26cce8 2019-08-04 stsp .Cm import .
139 74daf7cb 2020-01-27 stsp .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
140 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
141 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
142 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
143 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
144 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
148 5d7c1dab 2018-04-01 stsp .Ar work tree path
149 c844a238 2019-02-06 stsp is not specified, either use the last component of
150 5d7c1dab 2018-04-01 stsp .Ar repository path ,
152 5d7c1dab 2018-04-01 stsp .Ar path prefix
153 c844a238 2019-02-06 stsp was specified use the last component of
154 5d7c1dab 2018-04-01 stsp .Ar path prefix .
156 38e11793 2018-06-13 stsp The options for
157 38e11793 2018-06-13 stsp .Cm got checkout
158 38e11793 2018-06-13 stsp are as follows:
159 38e11793 2018-06-13 stsp .Bl -tag -width Ds
161 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
162 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
163 bb51a5b4 2020-01-13 stsp is not empty.
164 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
165 08573d5b 2019-05-14 stsp .It Fl b Ar branch
166 3c575567 2019-07-28 stsp Check out files from a commit on the specified
167 08573d5b 2019-05-14 stsp .Ar branch .
168 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
169 08573d5b 2019-05-14 stsp reference will be used.
170 8069f636 2019-01-12 stsp .It Fl c Ar commit
171 8069f636 2019-01-12 stsp Check out files from the specified
173 3c575567 2019-07-28 stsp on the selected branch.
174 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
175 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
176 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
177 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
178 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
179 08573d5b 2019-05-14 stsp branch will be used.
180 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
181 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
182 38e11793 2018-06-13 stsp Only files beneath the specified
183 38e11793 2018-06-13 stsp .Ar path-prefix
184 38e11793 2018-06-13 stsp will be checked out.
187 97b3a7be 2019-07-09 stsp Short alias for
188 97b3a7be 2019-07-09 stsp .Cm checkout .
189 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
190 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
191 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
192 7f838b36 2019-02-08 stsp .Bl -column YXZ description
193 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
194 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
195 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
196 7f838b36 2019-02-08 stsp .It D Ta file was deleted
197 7f838b36 2019-02-08 stsp .It A Ta new file was added
198 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
199 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
204 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
205 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
206 f2ea84fa 2019-07-27 stsp specified paths.
207 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
208 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
209 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
212 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
213 c4cdcb68 2019-04-03 stsp multiple base commits.
214 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
215 47ec7be7 2019-05-12 stsp .Cm got update
216 47ec7be7 2019-05-12 stsp across the entire work tree.
217 024e9686 2019-05-14 stsp Specifying a
219 024e9686 2019-05-14 stsp is incompatible with the
223 4ed9f614 2019-08-04 stsp .Cm got update
224 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
225 4ed9f614 2019-08-04 stsp If changes have been staged with
226 4ed9f614 2019-08-04 stsp .Cm got stage ,
227 bc3056e3 2019-08-18 stsp these changes must first be committed with
228 4ed9f614 2019-08-04 stsp .Cm got commit
229 4ed9f614 2019-08-04 stsp or unstaged with
230 4ed9f614 2019-08-04 stsp .Cm got unstage .
232 507dc3bb 2018-12-29 stsp The options for
233 507dc3bb 2018-12-29 stsp .Cm got update
234 507dc3bb 2018-12-29 stsp are as follows:
235 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
236 024e9686 2019-05-14 stsp .It Fl b Ar branch
237 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
239 024e9686 2019-05-14 stsp before updating the work tree.
240 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
241 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
242 507dc3bb 2018-12-29 stsp Update the work tree to the specified
243 507dc3bb 2018-12-29 stsp .Ar commit .
244 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
245 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
246 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
247 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
248 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
249 024e9686 2019-05-14 stsp branch will be used.
252 97b3a7be 2019-07-09 stsp Short alias for
253 97b3a7be 2019-07-09 stsp .Cm update .
254 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
255 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
256 6bad629b 2019-02-04 stsp using the following status codes:
257 6bad629b 2019-02-04 stsp .Bl -column YXZ description
258 6bad629b 2019-02-04 stsp .It M Ta modified file
259 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
260 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
261 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
262 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
263 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
264 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
266 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
267 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
269 2a06fe5f 2019-08-24 stsp specified on the command line
274 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
275 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
277 4ed9f614 2019-08-04 stsp If changes have been staged with
278 4ed9f614 2019-08-04 stsp .Cm got stage ,
279 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
280 4ed9f614 2019-08-04 stsp status codes:
281 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
282 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
283 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
284 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
287 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
288 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
289 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
290 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
293 6841da00 2019-08-08 stsp For compatibility with
296 bd8de430 2019-10-04 stsp .Xr git 1 ,
297 6841da00 2019-08-08 stsp .Cm got status
300 bd8de430 2019-10-04 stsp patterns from
301 6841da00 2019-08-08 stsp .Pa .cvsignore
303 bd8de430 2019-10-04 stsp .Pa .gitignore
304 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
305 bd8de430 2019-10-04 stsp which match these patterns.
306 bd8de430 2019-10-04 stsp As an extension to
308 bd8de430 2019-10-04 stsp matching rules,
309 bd8de430 2019-10-04 stsp .Cm got status
310 bd8de430 2019-10-04 stsp supports consecutive asterisks,
312 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
314 6841da00 2019-08-08 stsp .Xr cvs 1 ,
315 6841da00 2019-08-08 stsp .Cm got status
316 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
318 bd8de430 2019-10-04 stsp .Xr git 1 ,
319 bd8de430 2019-10-04 stsp .Cm got status
320 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
322 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
324 bd8de430 2019-10-04 stsp in a pattern.
326 97b3a7be 2019-07-09 stsp Short alias for
327 97b3a7be 2019-07-09 stsp .Cm status .
328 48c8c60d 2020-01-27 stsp .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Op Ar path
329 38e11793 2018-06-13 stsp Display history of a repository.
332 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
334 38e11793 2018-06-13 stsp The options for
335 38e11793 2018-06-13 stsp .Cm got log
336 38e11793 2018-06-13 stsp are as follows:
337 38e11793 2018-06-13 stsp .Bl -tag -width Ds
339 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
340 1137e0ae 2020-01-27 stsp from other branches.
341 48c8c60d 2020-01-27 stsp By default,
342 48c8c60d 2020-01-27 stsp .Cm got log
343 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
344 38e11793 2018-06-13 stsp .It Fl c Ar commit
345 38e11793 2018-06-13 stsp Start traversing history at the specified
346 38e11793 2018-06-13 stsp .Ar commit .
347 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
348 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
349 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
350 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
351 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
352 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
353 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
354 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
356 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
357 6238ee32 2018-06-13 stsp .It Fl l Ar N
358 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
359 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
360 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
362 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
363 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
365 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
368 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
369 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
370 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
371 6841bf13 2019-11-29 kn regular expression
372 6841bf13 2019-11-29 kn .Ar search-pattern .
373 6841bf13 2019-11-29 kn Regular expression syntax is documented in
374 6841bf13 2019-11-29 kn .Xr re_format 7 .
375 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
376 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
377 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
378 04ca23f4 2018-07-16 stsp working directory.
379 e9cf2e30 2019-02-05 stsp If this directory is a
381 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
383 63035f9f 2019-10-06 stsp .It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path
384 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
385 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
388 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
390 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
391 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
392 d24820bf 2019-08-11 stsp corresponding objects.
393 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
394 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
395 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
397 c0cc5c62 2018-10-18 stsp The options for
398 c0cc5c62 2018-10-18 stsp .Cm got diff
399 c0cc5c62 2018-10-18 stsp are as follows:
400 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
401 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
402 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
403 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
404 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
405 b72f483a 2019-02-05 stsp Use the repository at the specified path.
406 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
407 b72f483a 2019-02-05 stsp working directory.
408 b72f483a 2019-02-05 stsp If this directory is a
410 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
412 4ed9f614 2019-08-04 stsp Show changes staged with
413 4ed9f614 2019-08-04 stsp .Cm got stage
414 4ed9f614 2019-08-04 stsp instead of showing local changes.
415 4ed9f614 2019-08-04 stsp This option is only valid when
416 4ed9f614 2019-08-04 stsp .Cm got diff
417 4ed9f614 2019-08-04 stsp is invoked in a work tree.
419 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
422 bc26cce8 2019-08-04 stsp Short alias for
424 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
425 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
427 1ff8e573 2018-08-02 stsp The options for
428 1ff8e573 2018-08-02 stsp .Cm got blame
429 1ff8e573 2018-08-02 stsp are as follows:
430 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
431 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
432 1ff8e573 2018-08-02 stsp Start traversing history at the specified
433 1ff8e573 2018-08-02 stsp .Ar commit .
434 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
435 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
436 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
437 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
438 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
439 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
440 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
441 1ff8e573 2018-08-02 stsp working directory.
442 0c06baac 2019-02-05 stsp If this directory is a
444 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
447 bc26cce8 2019-08-04 stsp Short alias for
448 bc26cce8 2019-08-04 stsp .Cm blame .
449 dfc23429 2019-08-11 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl i Oc Oo Fl R Oc Op Ar path
450 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
451 5de5890b 2018-10-18 stsp directory path in the repository.
452 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
453 db0c2996 2019-02-10 stsp annotations:
454 db0c2996 2019-02-10 stsp .Bl -column YXZ description
455 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
456 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
457 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
458 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
463 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
464 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
465 0c849583 2019-02-05 stsp if there is no work tree.
467 5de5890b 2018-10-18 stsp The options for
468 5de5890b 2018-10-18 stsp .Cm got tree
469 5de5890b 2018-10-18 stsp are as follows:
470 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
471 5de5890b 2018-10-18 stsp .It Fl c Ar commit
472 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
473 5de5890b 2018-10-18 stsp .Ar commit .
474 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
475 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
476 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
477 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
478 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
479 5de5890b 2018-10-18 stsp Use the repository at the specified path.
480 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
481 5de5890b 2018-10-18 stsp working directory.
482 0c849583 2019-02-05 stsp If this directory is a
484 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
486 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
488 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
491 bc26cce8 2019-08-04 stsp Short alias for
493 c55aa27e 2019-08-12 stsp .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl s Oc Op Ar name Ar target
494 d0eebce4 2019-03-11 stsp Manage references in a repository.
496 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
497 d0eebce4 2019-03-11 stsp or update, the reference with the given
499 d0eebce4 2019-03-11 stsp and make it point at the given
500 d83d9d5c 2019-05-13 stsp .Ar target .
501 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
502 f16e4044 2019-10-09 stsp .Dq refs/ .
503 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
504 a54b6686 2019-06-28 stsp will be resolved to an object ID.
505 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
506 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
508 d0eebce4 2019-03-11 stsp The options for
509 d0eebce4 2019-03-11 stsp .Cm got ref
510 d0eebce4 2019-03-11 stsp are as follows:
511 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
512 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
513 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
514 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
515 d0eebce4 2019-03-11 stsp working directory.
516 d0eebce4 2019-03-11 stsp If this directory is a
518 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
520 d0eebce4 2019-03-11 stsp List all existing references in the repository.
521 d0eebce4 2019-03-11 stsp .It Fl d Ar name
522 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
524 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
525 d1c1ae5f 2019-08-12 stsp .Ar target ,
526 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
527 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
528 d1c1ae5f 2019-08-12 stsp this option is used.
530 a74f7e83 2019-11-10 stsp .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Op Ar name
531 4e759de4 2019-06-26 stsp Manage branches in a repository.
533 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
534 4e759de4 2019-06-26 stsp .Dq refs/heads/
535 4e759de4 2019-06-26 stsp reference namespace.
537 4e759de4 2019-06-26 stsp .Cm got branch
538 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
540 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
541 ad89fa31 2019-10-04 stsp work tree's current branch.
544 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
545 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
546 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
547 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
549 4e759de4 2019-06-26 stsp The options for
550 4e759de4 2019-06-26 stsp .Cm got branch
551 4e759de4 2019-06-26 stsp are as follows:
552 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
553 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
554 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
555 a74f7e83 2019-11-10 stsp .Ar commit .
556 a74f7e83 2019-11-10 stsp The expected
558 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
559 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
560 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
561 4e759de4 2019-06-26 stsp Use the repository at the specified path.
562 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
563 4e759de4 2019-06-26 stsp working directory.
564 4e759de4 2019-06-26 stsp If this directory is a
566 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
568 4e759de4 2019-06-26 stsp List all existing branches in the repository.
569 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
570 ba882ee3 2019-07-11 stsp with one the following annotations:
571 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
572 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
573 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
575 4e759de4 2019-06-26 stsp .It Fl d Ar name
576 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
577 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
578 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
579 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
580 ce33d90e 2019-07-14 stsp Git's garbage collector.
583 97b3a7be 2019-07-09 stsp Short alias for
584 97b3a7be 2019-07-09 stsp .Cm branch .
585 8b3ec12f 2019-12-08 kn .It Cm tag Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name Op Ar commit
586 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
588 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
589 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
590 8e7bd50a 2019-08-22 stsp reference namespace.
592 8e7bd50a 2019-08-22 stsp .Cm got tag
593 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
594 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
595 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
597 8e7bd50a 2019-08-22 stsp Expect one or two arguments and attempt to create a tag with the given
599 8e7bd50a 2019-08-22 stsp and make this tag point at the given
600 8e7bd50a 2019-08-22 stsp .Ar commit .
601 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
602 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
603 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
604 8e7bd50a 2019-08-22 stsp Otherwise, the expected argument is a commit ID SHA1 hash or an existing
605 8e7bd50a 2019-08-22 stsp reference or tag name which will be resolved to a commit ID.
606 8e7bd50a 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
607 8e7bd50a 2019-08-22 stsp automatically, provided the abbreviation is unique.
609 8e7bd50a 2019-08-22 stsp The options for
610 8e7bd50a 2019-08-22 stsp .Cm got tag
611 8e7bd50a 2019-08-22 stsp are as follows:
612 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
613 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
614 8e7bd50a 2019-08-22 stsp Use the specified tag message when creating the new tag
615 8e7bd50a 2019-08-22 stsp Without the
618 3a62228f 2019-11-08 stsp .Cm got tag
619 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
620 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
621 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
622 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
623 8e7bd50a 2019-08-22 stsp working directory.
624 8e7bd50a 2019-08-22 stsp If this directory is a
626 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
628 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
629 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
632 8e7bd50a 2019-08-22 stsp By design, the
633 8e7bd50a 2019-08-22 stsp .Cm got tag
634 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
635 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
636 8e7bd50a 2019-08-22 stsp .Cm got ref
637 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
638 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
639 8e7bd50a 2019-08-22 stsp another repository.
640 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
641 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
642 d00136be 2019-03-26 stsp repository in the next commit.
644 4e68cba3 2019-11-23 stsp The options for
645 4e68cba3 2019-11-23 stsp .Cm got add
646 4e68cba3 2019-11-23 stsp are as follows:
647 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
649 4e68cba3 2019-11-23 stsp Permit recursion into directories.
650 4e68cba3 2019-11-23 stsp If this option is not specified,
651 4e68cba3 2019-11-23 stsp .Cm got add
652 4e68cba3 2019-11-23 stsp will refuse to run if a specified
654 4e68cba3 2019-11-23 stsp is a directory.
656 022fae89 2019-12-06 tracey With -R, add files even if they match a
657 022fae89 2019-12-06 tracey .Cm got status
658 022fae89 2019-12-06 tracey ignore pattern.
660 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
661 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
662 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
664 2ec1f75b 2019-03-26 stsp The options for
665 86d25a1b 2019-07-11 stsp .Cm got remove
666 2ec1f75b 2019-03-26 stsp are as follows:
667 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
669 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
671 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
673 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
674 f2a9dc41 2019-12-13 tracey If this option is not specified,
675 f2a9dc41 2019-12-13 tracey .Cm got remove
676 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
678 f2a9dc41 2019-12-13 tracey is a directory.
681 648e4ef7 2019-07-09 stsp Short alias for
682 648e4ef7 2019-07-09 stsp .Cm remove .
683 dfc23429 2019-08-11 stsp .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
684 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
685 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
686 1dd86744 2019-08-12 anthony work tree's base commit.
687 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
688 a129376b 2019-03-28 stsp .Cm got revert !
690 e20a8b6f 2019-06-04 stsp If a file was added with
691 a129376b 2019-03-28 stsp .Cm got add
692 a129376b 2019-03-28 stsp it will become an unversioned file again.
693 e20a8b6f 2019-06-04 stsp If a file was deleted with
694 86d25a1b 2019-07-11 stsp .Cm got remove
695 a129376b 2019-03-28 stsp it will be restored.
697 0f6d7415 2019-08-08 stsp The options for
698 0f6d7415 2019-08-08 stsp .Cm got revert
699 0f6d7415 2019-08-08 stsp are as follows:
700 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
702 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
703 33aa809d 2019-08-08 stsp changes to revert based on
705 33aa809d 2019-08-08 stsp (revert change),
707 33aa809d 2019-08-08 stsp (keep change), and
709 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
710 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
711 33aa809d 2019-08-08 stsp modified file content can be reverted.
712 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
713 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
716 33aa809d 2019-08-08 stsp option, read
721 33aa809d 2019-08-08 stsp responses line-by-line from the specified
722 33aa809d 2019-08-08 stsp .Ar response-script
723 33aa809d 2019-08-08 stsp file instead of prompting interactively.
725 0f6d7415 2019-08-08 stsp Permit recursion into directories.
726 0f6d7415 2019-08-08 stsp If this option is not specified,
727 0f6d7415 2019-08-08 stsp .Cm got revert
728 0f6d7415 2019-08-08 stsp will refuse to run if a specified
730 0f6d7415 2019-08-08 stsp is a directory.
733 97b3a7be 2019-07-09 stsp Short alias for
734 97b3a7be 2019-07-09 stsp .Cm revert .
735 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
736 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
737 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
740 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
741 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
743 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
744 1dd86744 2019-08-12 anthony .Cm got stage ,
745 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
746 4ed9f614 2019-08-04 stsp have not been staged.
748 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
749 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
750 15cd91f7 2019-05-12 stsp .It M Ta modified file
751 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
752 15cd91f7 2019-05-12 stsp .It A Ta new file was added
753 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
756 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
757 996d5ccd 2019-08-05 stsp recorded base commit.
760 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
761 15cd91f7 2019-05-12 stsp multiple base commits.
762 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
763 47ec7be7 2019-05-12 stsp .Cm got update
764 47ec7be7 2019-05-12 stsp across the entire work tree.
767 15cd91f7 2019-05-12 stsp .Cm got commit
768 15cd91f7 2019-05-12 stsp command requires the
769 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
770 aba9c984 2019-09-08 stsp environment variable to be set,
771 aba9c984 2019-09-08 stsp unless Git's
772 aba9c984 2019-09-08 stsp .Dv user.name
774 709ae9eb 2019-09-08 stsp .Dv user.email
775 709ae9eb 2019-09-08 stsp configuration settings can be
776 aba9c984 2019-09-08 stsp obtained from the repository's
777 aba9c984 2019-09-08 stsp .Pa .git/config
778 c9956ddf 2019-09-08 stsp file or from Git's global
779 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
780 c9956ddf 2019-09-08 stsp configuration file.
782 74416c47 2019-05-09 stsp The options for
783 74416c47 2019-05-09 stsp .Cm got commit
784 74416c47 2019-05-09 stsp are as follows:
785 74416c47 2019-05-09 stsp .Bl -tag -width Ds
786 74ff3f23 2019-07-07 stsp .It Fl m Ar message
787 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
788 23594da9 2019-05-13 stsp Without the
791 23594da9 2019-05-13 stsp .Cm got commit
792 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
795 cfce0458 2019-07-28 stsp .Cm got commit
796 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
797 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
798 916f288c 2019-07-30 stsp .Dq refs/heads/
799 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
800 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
801 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
802 cfce0458 2019-07-28 stsp If a path is found to be out of date,
803 cfce0458 2019-07-28 stsp .Cm got update
804 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
805 cfce0458 2019-07-28 stsp in the repository.
807 97b3a7be 2019-07-09 stsp Short alias for
808 97b3a7be 2019-07-09 stsp .Cm commit .
809 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
810 234035bc 2019-06-01 stsp Merge changes from a single
812 234035bc 2019-06-01 stsp into the work tree.
813 234035bc 2019-06-01 stsp The specified
815 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
816 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
817 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
818 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
820 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
821 234035bc 2019-06-01 stsp .Bl -column YXZ description
822 234035bc 2019-06-01 stsp .It G Ta file was merged
823 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
824 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
825 234035bc 2019-06-01 stsp .It D Ta file was deleted
826 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
827 234035bc 2019-06-01 stsp .It A Ta new file was added
828 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
831 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
832 234035bc 2019-06-01 stsp may be viewed with
833 234035bc 2019-06-01 stsp .Cm got diff ,
834 234035bc 2019-06-01 stsp amended manually or with further
835 234035bc 2019-06-01 stsp .Cm got cherrypick
837 234035bc 2019-06-01 stsp committed with
838 234035bc 2019-06-01 stsp .Cm got commit ,
839 234035bc 2019-06-01 stsp or discarded again with
840 234035bc 2019-06-01 stsp .Cm got revert .
842 234035bc 2019-06-01 stsp .Cm got cherrypick
843 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
844 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
845 234035bc 2019-06-01 stsp to a single base commit with
846 234035bc 2019-06-01 stsp .Cm got update .
847 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
848 234035bc 2019-06-01 stsp conflicts must be resolved first.
850 97b3a7be 2019-07-09 stsp Short alias for
851 97b3a7be 2019-07-09 stsp .Cm cherrypick .
852 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
853 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
855 5ef14e63 2019-06-02 stsp into the work tree.
856 5ef14e63 2019-06-02 stsp The specified
858 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
859 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
860 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
861 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
863 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
864 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
865 5ef14e63 2019-06-02 stsp .It G Ta file was merged
866 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
867 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
868 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
869 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
870 5ef14e63 2019-06-02 stsp .It A Ta new file was added
871 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
874 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
875 5ef14e63 2019-06-02 stsp which may be viewed with
876 5ef14e63 2019-06-02 stsp .Cm got diff ,
877 5ef14e63 2019-06-02 stsp amended manually or with further
878 778a73c2 2019-07-12 stsp .Cm got backout
880 5ef14e63 2019-06-02 stsp committed with
881 5ef14e63 2019-06-02 stsp .Cm got commit ,
882 5ef14e63 2019-06-02 stsp or discarded again with
883 5ef14e63 2019-06-02 stsp .Cm got revert .
885 92228c38 2019-06-02 stsp .Cm got backout
886 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
887 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
888 92228c38 2019-06-02 stsp to a single base commit with
889 92228c38 2019-06-02 stsp .Cm got update .
890 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
891 92228c38 2019-06-02 stsp conflicts must be resolved first.
893 97b3a7be 2019-07-09 stsp Short alias for
894 97b3a7be 2019-07-09 stsp .Cm backout .
895 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
896 818c7501 2019-07-11 stsp Rebase commits on the specified
898 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
901 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
902 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
903 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
905 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
906 f09e2405 2019-07-11 stsp of the specified
908 f09e2405 2019-07-11 stsp has been rebased.
910 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
911 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
912 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
913 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
914 818c7501 2019-07-11 stsp .Ar branch ,
915 818c7501 2019-07-11 stsp but with different commit IDs.
916 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
917 f09e2405 2019-07-11 stsp the new version of the specified
919 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
921 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
922 818c7501 2019-07-11 stsp using the following status codes:
923 818c7501 2019-07-11 stsp .Bl -column YXZ description
924 818c7501 2019-07-11 stsp .It G Ta file was merged
925 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
926 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
927 818c7501 2019-07-11 stsp .It D Ta file was deleted
928 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
929 818c7501 2019-07-11 stsp .It A Ta new file was added
930 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
933 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
934 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
935 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
937 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
939 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
940 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
941 f09e2405 2019-07-11 stsp when the rebase operation continues.
943 818c7501 2019-07-11 stsp .Cm got rebase
944 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
945 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
946 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
947 818c7501 2019-07-11 stsp .Cm got update .
948 4ed9f614 2019-08-04 stsp If changes have been staged with
949 4ed9f614 2019-08-04 stsp .Cm got stage ,
950 bc3056e3 2019-08-18 stsp these changes must first be committed with
951 4ed9f614 2019-08-04 stsp .Cm got commit
952 4ed9f614 2019-08-04 stsp or unstaged with
953 4ed9f614 2019-08-04 stsp .Cm got unstage .
954 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
955 f09e2405 2019-07-11 stsp committed with
956 f09e2405 2019-07-11 stsp .Cm got commit
957 f09e2405 2019-07-11 stsp or reverted with
958 f09e2405 2019-07-11 stsp .Cm got revert .
961 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
962 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
965 7d5807f4 2019-07-11 stsp .Cm got update
967 7d5807f4 2019-07-11 stsp .Cm got commit
968 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
969 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
970 7d5807f4 2019-07-11 stsp conflict resolution purposes.
972 818c7501 2019-07-11 stsp The options for
973 818c7501 2019-07-11 stsp .Cm got rebase
974 818c7501 2019-07-11 stsp are as follows:
975 818c7501 2019-07-11 stsp .Bl -tag -width Ds
977 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
978 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
980 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
981 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
984 818c7501 2019-07-11 stsp Short alias for
985 818c7501 2019-07-11 stsp .Cm rebase .
986 dfc23429 2019-08-11 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
987 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
988 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
990 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
991 0ebf8283 2019-07-24 stsp .Ar histedit script
992 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
993 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
994 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
995 0ebf8283 2019-07-24 stsp whitespace and an argument.
996 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
997 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
998 0ebf8283 2019-07-24 stsp Lines which begin with the
1000 0ebf8283 2019-07-24 stsp character are ignored entirely.
1002 0ebf8283 2019-07-24 stsp The available commands are as follows:
1003 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1004 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1005 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1006 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1007 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1008 0ebf8283 2019-07-24 stsp listed further below that will be used.
1009 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1010 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1011 0ebf8283 2019-07-24 stsp the commit on the previous line.
1012 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1013 0ebf8283 2019-07-24 stsp log message can be written.
1016 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1017 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1019 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1020 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1021 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1022 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1023 498a90b7 2019-07-25 stsp switched to it.
1025 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1026 0ebf8283 2019-07-24 stsp using the following status codes:
1027 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1028 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1029 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1030 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1031 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1032 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1033 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1034 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1037 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1038 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1039 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1040 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1042 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1043 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1044 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1046 0ebf8283 2019-07-24 stsp .Cm got histedit
1047 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1048 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1049 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1050 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1051 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1052 0ebf8283 2019-07-24 stsp to a single base commit with
1053 0ebf8283 2019-07-24 stsp .Cm got update .
1054 4ed9f614 2019-08-04 stsp If changes have been staged with
1055 4ed9f614 2019-08-04 stsp .Cm got stage ,
1056 bc3056e3 2019-08-18 stsp these changes must first be committed with
1057 4ed9f614 2019-08-04 stsp .Cm got commit
1058 4ed9f614 2019-08-04 stsp or unstaged with
1059 4ed9f614 2019-08-04 stsp .Cm got unstage .
1060 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1061 0ebf8283 2019-07-24 stsp committed with
1062 0ebf8283 2019-07-24 stsp .Cm got commit
1063 0ebf8283 2019-07-24 stsp or reverted with
1064 0ebf8283 2019-07-24 stsp .Cm got revert .
1065 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1066 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1069 0ebf8283 2019-07-24 stsp .Cm got update
1070 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
1071 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1072 0ebf8283 2019-07-24 stsp .Cm got commit
1073 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1074 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1076 0ebf8283 2019-07-24 stsp The options for
1077 0ebf8283 2019-07-24 stsp .Cm got histedit
1078 0ebf8283 2019-07-24 stsp are as follows:
1079 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1081 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1082 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1084 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1085 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1088 0ebf8283 2019-07-24 stsp Short alias for
1089 0ebf8283 2019-07-24 stsp .Cm histedit .
1090 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1091 2822a352 2019-10-15 stsp Integrate the specified
1092 2822a352 2019-10-15 stsp .Ar branch
1093 2822a352 2019-10-15 stsp into the work tree's current branch.
1094 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1095 2822a352 2019-10-15 stsp .Ar branch ,
1096 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1097 2822a352 2019-10-15 stsp head commit of the integrated
1098 2822a352 2019-10-15 stsp .Ar branch .
1100 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1101 2822a352 2019-10-15 stsp will be pointing at the same commit.
1102 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1103 2822a352 2019-10-15 stsp In case the integrated
1104 2822a352 2019-10-15 stsp .Ar branch
1105 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1106 2822a352 2019-10-15 stsp .Cm got branch -d .
1108 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1109 2822a352 2019-10-15 stsp .Bl -column YXZ description
1110 2822a352 2019-10-15 stsp .It U Ta file was updated
1111 2822a352 2019-10-15 stsp .It D Ta file was deleted
1112 2822a352 2019-10-15 stsp .It A Ta new file was added
1113 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1114 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1117 2822a352 2019-10-15 stsp .Cm got integrate
1118 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1119 2822a352 2019-10-15 stsp Most importantly, the
1120 2822a352 2019-10-15 stsp .Ar branch
1121 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1122 2822a352 2019-10-15 stsp .Cm got rebase
1123 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1124 2822a352 2019-10-15 stsp resolve merge conflicts.
1125 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1126 2822a352 2019-10-15 stsp to a single base commit with
1127 2822a352 2019-10-15 stsp .Cm got update .
1128 2822a352 2019-10-15 stsp If changes have been staged with
1129 2822a352 2019-10-15 stsp .Cm got stage ,
1130 2822a352 2019-10-15 stsp these changes must first be committed with
1131 2822a352 2019-10-15 stsp .Cm got commit
1132 2822a352 2019-10-15 stsp or unstaged with
1133 2822a352 2019-10-15 stsp .Cm got unstage .
1134 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1135 2822a352 2019-10-15 stsp committed with
1136 2822a352 2019-10-15 stsp .Cm got commit
1137 2822a352 2019-10-15 stsp or reverted with
1138 2822a352 2019-10-15 stsp .Cm got revert .
1140 2822a352 2019-10-15 stsp Short alias for
1141 2822a352 2019-10-15 stsp .Cm integrate .
1142 dfc23429 2019-08-11 stsp .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1143 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1146 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1147 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1148 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1149 4ed9f614 2019-08-04 stsp .Cm got status .
1151 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1152 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1153 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1154 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1155 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1158 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1159 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1160 9d8b19a4 2019-08-04 stsp committed.
1162 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1163 4ed9f614 2019-08-04 stsp .Cm got commit ,
1164 4ed9f614 2019-08-04 stsp .Cm got status ,
1166 4ed9f614 2019-08-04 stsp .Cm got diff .
1167 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1168 4ed9f614 2019-08-04 stsp .Cm got commit
1169 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1170 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1171 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1173 4ed9f614 2019-08-04 stsp .Cm got status
1174 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1176 4ed9f614 2019-08-04 stsp .Cm got diff
1177 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1178 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1180 4ed9f614 2019-08-04 stsp .Cm got revert
1181 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1182 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1184 4ed9f614 2019-08-04 stsp The options for
1185 4ed9f614 2019-08-04 stsp .Cm got stage
1186 4ed9f614 2019-08-04 stsp are as follows:
1187 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1189 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1190 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1191 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1192 1dd86744 2019-08-12 anthony among the specified paths.
1193 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1195 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1196 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1198 6d23ec10 2019-08-08 stsp (stage change),
1200 6d23ec10 2019-08-08 stsp (reject change), and
1202 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1203 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1204 dc424a06 2019-08-07 stsp modified file content can be staged.
1205 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1206 6d23ec10 2019-08-08 stsp their entirety.
1207 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1210 3a070a2b 2019-08-07 stsp option, read
1215 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1216 0e2f5884 2019-08-07 stsp .Ar response-script
1217 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1220 4ed9f614 2019-08-04 stsp .Cm got stage
1221 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1222 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1223 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1224 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1225 4ed9f614 2019-08-04 stsp .Cm got update
1226 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1227 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1230 4ed9f614 2019-08-04 stsp .Cm got update ,
1231 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1233 4ed9f614 2019-08-04 stsp .Cm got histedit
1234 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1235 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1236 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1237 4ed9f614 2019-08-04 stsp .Cm got unstage
1238 4ed9f614 2019-08-04 stsp before it can be updated with
1239 4ed9f614 2019-08-04 stsp .Cm got update ,
1240 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1242 4ed9f614 2019-08-04 stsp Short alias for
1243 4ed9f614 2019-08-04 stsp .Cm stage .
1244 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1245 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1246 4ed9f614 2019-08-04 stsp back into non-staged status.
1249 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1250 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1252 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1253 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1254 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1255 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1256 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1257 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1258 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1259 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1262 2e1f37b0 2019-08-08 stsp The options for
1263 2e1f37b0 2019-08-08 stsp .Cm got unstage
1264 2e1f37b0 2019-08-08 stsp are as follows:
1265 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1267 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1268 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1270 2e1f37b0 2019-08-08 stsp (unstage change),
1272 2e1f37b0 2019-08-08 stsp (keep change staged), and
1274 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1275 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1276 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1277 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1278 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1281 2e1f37b0 2019-08-08 stsp option, read
1286 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1287 2e1f37b0 2019-08-08 stsp .Ar response-script
1288 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1291 4ed9f614 2019-08-04 stsp Short alias for
1292 4ed9f614 2019-08-04 stsp .Cm unstage .
1293 5be72254 2019-08-26 stsp .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1294 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1295 896e9b6f 2019-08-26 stsp text format.
1296 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1297 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1298 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1300 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1301 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1302 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1303 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1304 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1305 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1307 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1309 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1310 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1312 01073a5d 2019-08-22 stsp The options for
1313 01073a5d 2019-08-22 stsp .Cm got cat
1314 01073a5d 2019-08-22 stsp are as follows:
1315 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1316 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1317 896e9b6f 2019-08-26 stsp Look up paths in the specified
1318 896e9b6f 2019-08-26 stsp .Ar commit .
1319 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1320 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1321 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1322 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1323 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1324 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1325 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1326 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1327 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1328 01073a5d 2019-08-22 stsp working directory.
1329 01073a5d 2019-08-22 stsp If this directory is a
1331 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1333 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1334 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1335 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1338 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1339 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1340 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1341 74416c47 2019-05-09 stsp The author's name and email address for
1342 21a44f98 2019-07-15 stsp .Cm got commit
1344 21a44f98 2019-07-15 stsp .Cm got import ,
1345 74416c47 2019-05-09 stsp for example:
1346 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1349 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1351 84792843 2019-08-09 stsp attempts to reject
1352 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1353 84792843 2019-08-09 stsp environment variables with a missing email address.
1355 c9956ddf 2019-09-08 stsp If present, Git's
1356 aba9c984 2019-09-08 stsp .Dv user.name
1358 709ae9eb 2019-09-08 stsp .Dv user.email
1359 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1360 aba9c984 2019-09-08 stsp .Pa .git/config
1361 aba9c984 2019-09-08 stsp file will override the value of
1362 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1363 c9956ddf 2019-09-08 stsp However, the
1364 c9956ddf 2019-09-08 stsp .Dv user.name
1366 c9956ddf 2019-09-08 stsp .Dv user.email
1367 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1368 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1369 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1370 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1371 c9956ddf 2019-09-08 stsp environment variable is
1374 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1375 23594da9 2019-05-13 stsp The editor spawned by
1376 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1377 8e7bd50a 2019-08-22 stsp .Cm got import ,
1379 8e7bd50a 2019-08-22 stsp .Cm got tag .
1380 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1381 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1382 b1ebc001 2019-08-13 stsp .Cm got log .
1383 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1384 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1386 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1387 5c860e29 2018-03-12 stsp .Ex -std got
1388 97925469 2018-03-17 stsp .Sh EXAMPLES
1389 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1391 fa6e0e48 2019-05-23 stsp This step currently requires
1392 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1394 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1395 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1397 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1399 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1400 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1401 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1403 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1404 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1406 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1408 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1410 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1412 e70c17ce 2019-05-22 stsp .Dl $ got status
1413 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1415 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1417 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1419 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1421 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1423 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1424 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1425 d83d9d5c 2019-05-13 stsp which is forked off the
1426 d83d9d5c 2019-05-13 stsp .Dq master
1429 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1431 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1432 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1433 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1435 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1437 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1438 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1440 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1442 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1443 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1444 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1446 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1448 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1450 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1451 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1453 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1454 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1456 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1458 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1459 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1460 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1462 95fc3404 2019-07-15 stsp .Dl $ got update
1464 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1465 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1466 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1468 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1469 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1470 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1471 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1473 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
1474 9221fb1e 2019-06-26 stsp This step currently requires
1475 9221fb1e 2019-06-26 stsp .Xr git 1 :
1477 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1478 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
1480 fa6e0e48 2019-05-23 stsp Rebase the
1481 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1482 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1483 fa6e0e48 2019-05-23 stsp .Dq master
1486 818c7501 2019-07-11 stsp .Dl $ got update -b master
1487 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1489 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1490 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1491 1dd86744 2019-08-12 anthony .Ox Ns 's
1492 1dd86744 2019-08-12 anthony CVS tree:
1494 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1496 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1497 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1500 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1501 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1502 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1504 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
1505 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1506 7b3fde24 2019-07-28 stsp .Cm git fetch
1508 7b3fde24 2019-07-28 stsp .Cm git push .
1509 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1510 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
1512 ff2cf171 2019-07-28 stsp .Dq refspec
1513 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1515 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1516 ff2cf171 2019-07-28 stsp namespace of the local repository.
1517 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1518 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1519 ff2cf171 2019-07-28 stsp configuration variable to the value
1520 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1522 ff2cf171 2019-07-28 stsp .Cm git config
1525 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1526 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1528 ff2cf171 2019-07-28 stsp Alternatively, the following
1530 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1531 ff2cf171 2019-07-28 stsp .Pa config
1534 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1535 ff2cf171 2019-07-28 stsp .Dl url = ...
1536 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1538 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1539 ff2cf171 2019-07-28 stsp .Dq refs/heads
1540 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1541 ff2cf171 2019-07-28 stsp .Cm got checkout
1542 ff2cf171 2019-07-28 stsp and, if needed, created with
1543 ff2cf171 2019-07-28 stsp .Cm got branch .
1545 ff2cf171 2019-07-28 stsp Branches in the
1546 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1547 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
1548 ff2cf171 2019-07-28 stsp repository with
1549 ff2cf171 2019-07-28 stsp .Cm git fetch :
1551 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1552 ff2cf171 2019-07-28 stsp .Dl $ git fetch
1554 ff2cf171 2019-07-28 stsp Before outgoing changes on the local
1555 ff2cf171 2019-07-28 stsp .Dq master
1556 ff2cf171 2019-07-28 stsp branch can be pushed to the remote repository, the local
1557 ff2cf171 2019-07-28 stsp .Dq master
1558 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1559 ff2cf171 2019-07-28 stsp .Dq origin/master
1562 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1563 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1565 ff2cf171 2019-07-28 stsp Changes on the local
1566 ff2cf171 2019-07-28 stsp .Dq master
1567 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1568 ff2cf171 2019-07-28 stsp repository with
1569 ff2cf171 2019-07-28 stsp .Cm git push :
1571 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1572 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1574 14c25ea2 2019-10-15 stsp In order to merge changes committed to the
1575 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1576 14c25ea2 2019-10-15 stsp branch back into the
1577 14c25ea2 2019-10-15 stsp .Dq master
1578 14c25ea2 2019-10-15 stsp branch, the
1579 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1580 14c25ea2 2019-10-15 stsp branch must first be rebased onto the
1581 14c25ea2 2019-10-15 stsp .Dq master
1584 14c25ea2 2019-10-15 stsp .Dl $ got update -b master
1585 14c25ea2 2019-10-15 stsp .Dl $ got rebase unified-buffer-cache
1587 14c25ea2 2019-10-15 stsp Changes on the
1588 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1589 14c25ea2 2019-10-15 stsp branch can now be made visible on the
1590 14c25ea2 2019-10-15 stsp .Dq master
1591 14c25ea2 2019-10-15 stsp branch with
1592 14c25ea2 2019-10-15 stsp .Cm got integrate .
1593 14c25ea2 2019-10-15 stsp Because the rebase operation switched the work tree to the
1594 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1595 14c25ea2 2019-10-15 stsp branch, the work tree must be switched back to the
1596 14c25ea2 2019-10-15 stsp .Dq master
1597 14c25ea2 2019-10-15 stsp branch before the
1598 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1599 14c25ea2 2019-10-15 stsp branch can be integrated into
1600 14c25ea2 2019-10-15 stsp .Dq master :
1602 14c25ea2 2019-10-15 stsp .Dl $ got update -b master
1603 14c25ea2 2019-10-15 stsp .Dl $ got integrate unified-buffer-cache
1604 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1605 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1606 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1607 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1608 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1609 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1610 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1611 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1612 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1614 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1615 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1617 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1618 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
