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.
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 dfc23429 2019-08-11 stsp .It Cm checkout 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.
142 5d7c1dab 2018-04-01 stsp .Ar work tree path
143 c844a238 2019-02-06 stsp is not specified, either use the last component of
144 5d7c1dab 2018-04-01 stsp .Ar repository path ,
146 5d7c1dab 2018-04-01 stsp .Ar path prefix
147 c844a238 2019-02-06 stsp was specified use the last component of
148 5d7c1dab 2018-04-01 stsp .Ar path prefix .
150 38e11793 2018-06-13 stsp The options for
151 38e11793 2018-06-13 stsp .Cm got checkout
152 38e11793 2018-06-13 stsp are as follows:
153 38e11793 2018-06-13 stsp .Bl -tag -width Ds
154 08573d5b 2019-05-14 stsp .It Fl b Ar branch
155 3c575567 2019-07-28 stsp Check out files from a commit on the specified
156 08573d5b 2019-05-14 stsp .Ar branch .
157 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
158 08573d5b 2019-05-14 stsp reference will be used.
159 8069f636 2019-01-12 stsp .It Fl c Ar commit
160 8069f636 2019-01-12 stsp Check out files from the specified
162 3c575567 2019-07-28 stsp on the selected branch.
163 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
164 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
165 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
166 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
167 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
168 08573d5b 2019-05-14 stsp branch will be used.
169 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
170 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
171 38e11793 2018-06-13 stsp Only files beneath the specified
172 38e11793 2018-06-13 stsp .Ar path-prefix
173 38e11793 2018-06-13 stsp will be checked out.
176 97b3a7be 2019-07-09 stsp Short alias for
177 97b3a7be 2019-07-09 stsp .Cm checkout .
178 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
179 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
180 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
181 7f838b36 2019-02-08 stsp .Bl -column YXZ description
182 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
183 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
184 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
185 7f838b36 2019-02-08 stsp .It D Ta file was deleted
186 7f838b36 2019-02-08 stsp .It A Ta new file was added
187 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
188 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
193 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
194 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
195 f2ea84fa 2019-07-27 stsp specified paths.
196 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
197 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
198 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
201 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
202 c4cdcb68 2019-04-03 stsp multiple base commits.
203 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
204 47ec7be7 2019-05-12 stsp .Cm got update
205 47ec7be7 2019-05-12 stsp across the entire work tree.
206 024e9686 2019-05-14 stsp Specifying a
208 024e9686 2019-05-14 stsp is incompatible with the
212 4ed9f614 2019-08-04 stsp .Cm got update
213 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
214 4ed9f614 2019-08-04 stsp If changes have been staged with
215 4ed9f614 2019-08-04 stsp .Cm got stage ,
216 bc3056e3 2019-08-18 stsp these changes must first be committed with
217 4ed9f614 2019-08-04 stsp .Cm got commit
218 4ed9f614 2019-08-04 stsp or unstaged with
219 4ed9f614 2019-08-04 stsp .Cm got unstage .
221 507dc3bb 2018-12-29 stsp The options for
222 507dc3bb 2018-12-29 stsp .Cm got update
223 507dc3bb 2018-12-29 stsp are as follows:
224 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
225 024e9686 2019-05-14 stsp .It Fl b Ar branch
226 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
228 024e9686 2019-05-14 stsp before updating the work tree.
229 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
230 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
231 507dc3bb 2018-12-29 stsp Update the work tree to the specified
232 507dc3bb 2018-12-29 stsp .Ar commit .
233 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
234 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
235 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
236 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
237 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
238 024e9686 2019-05-14 stsp branch will be used.
241 97b3a7be 2019-07-09 stsp Short alias for
242 97b3a7be 2019-07-09 stsp .Cm update .
243 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
244 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
245 6bad629b 2019-02-04 stsp using the following status codes:
246 6bad629b 2019-02-04 stsp .Bl -column YXZ description
247 6bad629b 2019-02-04 stsp .It M Ta modified file
248 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
249 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
250 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
251 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
252 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
253 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
255 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
256 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
258 2a06fe5f 2019-08-24 stsp specified on the command line
263 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
264 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
266 4ed9f614 2019-08-04 stsp If changes have been staged with
267 4ed9f614 2019-08-04 stsp .Cm got stage ,
268 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
269 4ed9f614 2019-08-04 stsp status codes:
270 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
271 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
272 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
273 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
276 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
277 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
278 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
279 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
282 6841da00 2019-08-08 stsp For compatibility with
285 bd8de430 2019-10-04 stsp .Xr git 1 ,
286 6841da00 2019-08-08 stsp .Cm got status
289 bd8de430 2019-10-04 stsp patterns from
290 6841da00 2019-08-08 stsp .Pa .cvsignore
292 bd8de430 2019-10-04 stsp .Pa .gitignore
293 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
294 bd8de430 2019-10-04 stsp which match these patterns.
295 bd8de430 2019-10-04 stsp As an extension to
297 bd8de430 2019-10-04 stsp matching rules,
298 bd8de430 2019-10-04 stsp .Cm got status
299 bd8de430 2019-10-04 stsp supports consecutive asterisks,
301 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
303 6841da00 2019-08-08 stsp .Xr cvs 1 ,
304 6841da00 2019-08-08 stsp .Cm got status
305 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
307 bd8de430 2019-10-04 stsp .Xr git 1 ,
308 bd8de430 2019-10-04 stsp .Cm got status
309 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
311 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
313 bd8de430 2019-10-04 stsp in a pattern.
315 97b3a7be 2019-07-09 stsp Short alias for
316 97b3a7be 2019-07-09 stsp .Cm status .
317 c6390436 2019-11-29 kn .It Cm log Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl f 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
318 38e11793 2018-06-13 stsp Display history of a repository.
321 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
323 38e11793 2018-06-13 stsp The options for
324 38e11793 2018-06-13 stsp .Cm got log
325 38e11793 2018-06-13 stsp are as follows:
326 38e11793 2018-06-13 stsp .Bl -tag -width Ds
327 38e11793 2018-06-13 stsp .It Fl c Ar commit
328 38e11793 2018-06-13 stsp Start traversing history at the specified
329 38e11793 2018-06-13 stsp .Ar commit .
330 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
331 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
332 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
333 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
334 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
335 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
336 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
337 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
339 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
341 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
342 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
343 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
344 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
345 6238ee32 2018-06-13 stsp .It Fl l Ar N
346 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
347 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
348 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
350 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
351 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
353 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
356 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
357 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
358 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
359 6841bf13 2019-11-29 kn regular expression
360 6841bf13 2019-11-29 kn .Ar search-pattern .
361 6841bf13 2019-11-29 kn Regular expression syntax is documented in
362 6841bf13 2019-11-29 kn .Xr re_format 7 .
363 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
364 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
365 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
366 04ca23f4 2018-07-16 stsp working directory.
367 e9cf2e30 2019-02-05 stsp If this directory is a
369 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
371 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
372 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
373 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
376 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
378 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
379 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
380 d24820bf 2019-08-11 stsp corresponding objects.
381 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
382 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
383 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
385 c0cc5c62 2018-10-18 stsp The options for
386 c0cc5c62 2018-10-18 stsp .Cm got diff
387 c0cc5c62 2018-10-18 stsp are as follows:
388 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
389 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
390 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
391 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
392 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
393 b72f483a 2019-02-05 stsp Use the repository at the specified path.
394 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
395 b72f483a 2019-02-05 stsp working directory.
396 b72f483a 2019-02-05 stsp If this directory is a
398 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
400 4ed9f614 2019-08-04 stsp Show changes staged with
401 4ed9f614 2019-08-04 stsp .Cm got stage
402 4ed9f614 2019-08-04 stsp instead of showing local changes.
403 4ed9f614 2019-08-04 stsp This option is only valid when
404 4ed9f614 2019-08-04 stsp .Cm got diff
405 4ed9f614 2019-08-04 stsp is invoked in a work tree.
407 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
410 bc26cce8 2019-08-04 stsp Short alias for
412 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
413 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
415 1ff8e573 2018-08-02 stsp The options for
416 1ff8e573 2018-08-02 stsp .Cm got blame
417 1ff8e573 2018-08-02 stsp are as follows:
418 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
419 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
420 1ff8e573 2018-08-02 stsp Start traversing history at the specified
421 1ff8e573 2018-08-02 stsp .Ar commit .
422 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
423 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
424 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
425 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
426 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
427 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
428 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
429 1ff8e573 2018-08-02 stsp working directory.
430 0c06baac 2019-02-05 stsp If this directory is a
432 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
435 bc26cce8 2019-08-04 stsp Short alias for
436 bc26cce8 2019-08-04 stsp .Cm blame .
437 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
438 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
439 5de5890b 2018-10-18 stsp directory path in the repository.
440 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
441 db0c2996 2019-02-10 stsp annotations:
442 db0c2996 2019-02-10 stsp .Bl -column YXZ description
443 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
444 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
445 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
446 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
451 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
452 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
453 0c849583 2019-02-05 stsp if there is no work tree.
455 5de5890b 2018-10-18 stsp The options for
456 5de5890b 2018-10-18 stsp .Cm got tree
457 5de5890b 2018-10-18 stsp are as follows:
458 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
459 5de5890b 2018-10-18 stsp .It Fl c Ar commit
460 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
461 5de5890b 2018-10-18 stsp .Ar commit .
462 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
463 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
464 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
465 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
466 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
467 5de5890b 2018-10-18 stsp Use the repository at the specified path.
468 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
469 5de5890b 2018-10-18 stsp working directory.
470 0c849583 2019-02-05 stsp If this directory is a
472 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
474 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
476 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
479 bc26cce8 2019-08-04 stsp Short alias for
481 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
482 d0eebce4 2019-03-11 stsp Manage references in a repository.
484 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
485 d0eebce4 2019-03-11 stsp or update, the reference with the given
487 d0eebce4 2019-03-11 stsp and make it point at the given
488 d83d9d5c 2019-05-13 stsp .Ar target .
489 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
490 f16e4044 2019-10-09 stsp .Dq refs/ .
491 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
492 a54b6686 2019-06-28 stsp will be resolved to an object ID.
493 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
494 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
496 d0eebce4 2019-03-11 stsp The options for
497 d0eebce4 2019-03-11 stsp .Cm got ref
498 d0eebce4 2019-03-11 stsp are as follows:
499 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
500 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
501 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
502 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
503 d0eebce4 2019-03-11 stsp working directory.
504 d0eebce4 2019-03-11 stsp If this directory is a
506 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
508 d0eebce4 2019-03-11 stsp List all existing references in the repository.
509 d0eebce4 2019-03-11 stsp .It Fl d Ar name
510 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
512 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
513 d1c1ae5f 2019-08-12 stsp .Ar target ,
514 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
515 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
516 d1c1ae5f 2019-08-12 stsp this option is used.
518 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
519 4e759de4 2019-06-26 stsp Manage branches in a repository.
521 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
522 4e759de4 2019-06-26 stsp .Dq refs/heads/
523 4e759de4 2019-06-26 stsp reference namespace.
525 4e759de4 2019-06-26 stsp .Cm got branch
526 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
528 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
529 ad89fa31 2019-10-04 stsp work tree's current branch.
532 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
533 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
534 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
535 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
537 4e759de4 2019-06-26 stsp The options for
538 4e759de4 2019-06-26 stsp .Cm got branch
539 4e759de4 2019-06-26 stsp are as follows:
540 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
541 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
542 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
543 a74f7e83 2019-11-10 stsp .Ar commit .
544 a74f7e83 2019-11-10 stsp The expected
546 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
547 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
548 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
549 4e759de4 2019-06-26 stsp Use the repository at the specified path.
550 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
551 4e759de4 2019-06-26 stsp working directory.
552 4e759de4 2019-06-26 stsp If this directory is a
554 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
556 4e759de4 2019-06-26 stsp List all existing branches in the repository.
557 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
558 ba882ee3 2019-07-11 stsp with one the following annotations:
559 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
560 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
561 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
563 4e759de4 2019-06-26 stsp .It Fl d Ar name
564 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
565 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
566 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
567 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
568 ce33d90e 2019-07-14 stsp Git's garbage collector.
571 97b3a7be 2019-07-09 stsp Short alias for
572 97b3a7be 2019-07-09 stsp .Cm branch .
573 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
574 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
576 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
577 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
578 8e7bd50a 2019-08-22 stsp reference namespace.
580 8e7bd50a 2019-08-22 stsp .Cm got tag
581 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
582 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
583 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
585 8e7bd50a 2019-08-22 stsp Expect one or two arguments and attempt to create a tag with the given
587 8e7bd50a 2019-08-22 stsp and make this tag point at the given
588 8e7bd50a 2019-08-22 stsp .Ar commit .
589 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
590 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
591 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
592 8e7bd50a 2019-08-22 stsp Otherwise, the expected argument is a commit ID SHA1 hash or an existing
593 8e7bd50a 2019-08-22 stsp reference or tag name which will be resolved to a commit ID.
594 8e7bd50a 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
595 8e7bd50a 2019-08-22 stsp automatically, provided the abbreviation is unique.
597 8e7bd50a 2019-08-22 stsp The options for
598 8e7bd50a 2019-08-22 stsp .Cm got tag
599 8e7bd50a 2019-08-22 stsp are as follows:
600 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
601 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
602 8e7bd50a 2019-08-22 stsp Use the specified tag message when creating the new tag
603 8e7bd50a 2019-08-22 stsp Without the
606 3a62228f 2019-11-08 stsp .Cm got tag
607 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
608 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
609 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
610 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
611 8e7bd50a 2019-08-22 stsp working directory.
612 8e7bd50a 2019-08-22 stsp If this directory is a
614 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
616 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
617 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
620 8e7bd50a 2019-08-22 stsp By design, the
621 8e7bd50a 2019-08-22 stsp .Cm got tag
622 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
623 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
624 8e7bd50a 2019-08-22 stsp .Cm got ref
625 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
626 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
627 8e7bd50a 2019-08-22 stsp another repository.
628 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
629 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
630 d00136be 2019-03-26 stsp repository in the next commit.
632 4e68cba3 2019-11-23 stsp The options for
633 4e68cba3 2019-11-23 stsp .Cm got add
634 4e68cba3 2019-11-23 stsp are as follows:
635 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
637 4e68cba3 2019-11-23 stsp Permit recursion into directories.
638 4e68cba3 2019-11-23 stsp If this option is not specified,
639 4e68cba3 2019-11-23 stsp .Cm got add
640 4e68cba3 2019-11-23 stsp will refuse to run if a specified
642 4e68cba3 2019-11-23 stsp is a directory.
644 022fae89 2019-12-06 tracey With -R, add files even if they match a
645 022fae89 2019-12-06 tracey .Cm got status
646 022fae89 2019-12-06 tracey ignore pattern.
648 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
649 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
650 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
652 2ec1f75b 2019-03-26 stsp The options for
653 86d25a1b 2019-07-11 stsp .Cm got remove
654 2ec1f75b 2019-03-26 stsp are as follows:
655 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
657 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
659 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
661 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
662 f2a9dc41 2019-12-13 tracey If this option is not specified,
663 f2a9dc41 2019-12-13 tracey .Cm got remove
664 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
666 f2a9dc41 2019-12-13 tracey is a directory.
669 648e4ef7 2019-07-09 stsp Short alias for
670 648e4ef7 2019-07-09 stsp .Cm remove .
671 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 ...
672 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
673 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
674 1dd86744 2019-08-12 anthony work tree's base commit.
675 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
676 a129376b 2019-03-28 stsp .Cm got revert !
678 e20a8b6f 2019-06-04 stsp If a file was added with
679 a129376b 2019-03-28 stsp .Cm got add
680 a129376b 2019-03-28 stsp it will become an unversioned file again.
681 e20a8b6f 2019-06-04 stsp If a file was deleted with
682 86d25a1b 2019-07-11 stsp .Cm got remove
683 a129376b 2019-03-28 stsp it will be restored.
685 0f6d7415 2019-08-08 stsp The options for
686 0f6d7415 2019-08-08 stsp .Cm got revert
687 0f6d7415 2019-08-08 stsp are as follows:
688 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
690 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
691 33aa809d 2019-08-08 stsp changes to revert based on
693 33aa809d 2019-08-08 stsp (revert change),
695 33aa809d 2019-08-08 stsp (keep change), and
697 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
698 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
699 33aa809d 2019-08-08 stsp modified file content can be reverted.
700 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
701 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
704 33aa809d 2019-08-08 stsp option, read
709 33aa809d 2019-08-08 stsp responses line-by-line from the specified
710 33aa809d 2019-08-08 stsp .Ar response-script
711 33aa809d 2019-08-08 stsp file instead of prompting interactively.
713 0f6d7415 2019-08-08 stsp Permit recursion into directories.
714 0f6d7415 2019-08-08 stsp If this option is not specified,
715 0f6d7415 2019-08-08 stsp .Cm got revert
716 0f6d7415 2019-08-08 stsp will refuse to run if a specified
718 0f6d7415 2019-08-08 stsp is a directory.
721 97b3a7be 2019-07-09 stsp Short alias for
722 97b3a7be 2019-07-09 stsp .Cm revert .
723 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
724 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
725 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
728 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
729 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
731 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
732 1dd86744 2019-08-12 anthony .Cm got stage ,
733 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
734 4ed9f614 2019-08-04 stsp have not been staged.
736 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
737 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
738 15cd91f7 2019-05-12 stsp .It M Ta modified file
739 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
740 15cd91f7 2019-05-12 stsp .It A Ta new file was added
741 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
744 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
745 996d5ccd 2019-08-05 stsp recorded base commit.
748 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
749 15cd91f7 2019-05-12 stsp multiple base commits.
750 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
751 47ec7be7 2019-05-12 stsp .Cm got update
752 47ec7be7 2019-05-12 stsp across the entire work tree.
755 15cd91f7 2019-05-12 stsp .Cm got commit
756 15cd91f7 2019-05-12 stsp command requires the
757 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
758 aba9c984 2019-09-08 stsp environment variable to be set,
759 aba9c984 2019-09-08 stsp unless Git's
760 aba9c984 2019-09-08 stsp .Dv user.name
762 709ae9eb 2019-09-08 stsp .Dv user.email
763 709ae9eb 2019-09-08 stsp configuration settings can be
764 aba9c984 2019-09-08 stsp obtained from the repository's
765 aba9c984 2019-09-08 stsp .Pa .git/config
766 c9956ddf 2019-09-08 stsp file or from Git's global
767 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
768 c9956ddf 2019-09-08 stsp configuration file.
770 74416c47 2019-05-09 stsp The options for
771 74416c47 2019-05-09 stsp .Cm got commit
772 74416c47 2019-05-09 stsp are as follows:
773 74416c47 2019-05-09 stsp .Bl -tag -width Ds
774 74ff3f23 2019-07-07 stsp .It Fl m Ar message
775 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
776 23594da9 2019-05-13 stsp Without the
779 23594da9 2019-05-13 stsp .Cm got commit
780 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
783 cfce0458 2019-07-28 stsp .Cm got commit
784 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
785 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
786 916f288c 2019-07-30 stsp .Dq refs/heads/
787 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
788 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
789 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
790 cfce0458 2019-07-28 stsp If a path is found to be out of date,
791 cfce0458 2019-07-28 stsp .Cm got update
792 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
793 cfce0458 2019-07-28 stsp in the repository.
795 97b3a7be 2019-07-09 stsp Short alias for
796 97b3a7be 2019-07-09 stsp .Cm commit .
797 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
798 234035bc 2019-06-01 stsp Merge changes from a single
800 234035bc 2019-06-01 stsp into the work tree.
801 234035bc 2019-06-01 stsp The specified
803 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
804 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
805 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
806 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
808 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
809 234035bc 2019-06-01 stsp .Bl -column YXZ description
810 234035bc 2019-06-01 stsp .It G Ta file was merged
811 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
812 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
813 234035bc 2019-06-01 stsp .It D Ta file was deleted
814 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
815 234035bc 2019-06-01 stsp .It A Ta new file was added
816 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
819 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
820 234035bc 2019-06-01 stsp may be viewed with
821 234035bc 2019-06-01 stsp .Cm got diff ,
822 234035bc 2019-06-01 stsp amended manually or with further
823 234035bc 2019-06-01 stsp .Cm got cherrypick
825 234035bc 2019-06-01 stsp committed with
826 234035bc 2019-06-01 stsp .Cm got commit ,
827 234035bc 2019-06-01 stsp or discarded again with
828 234035bc 2019-06-01 stsp .Cm got revert .
830 234035bc 2019-06-01 stsp .Cm got cherrypick
831 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
832 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
833 234035bc 2019-06-01 stsp to a single base commit with
834 234035bc 2019-06-01 stsp .Cm got update .
835 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
836 234035bc 2019-06-01 stsp conflicts must be resolved first.
838 97b3a7be 2019-07-09 stsp Short alias for
839 97b3a7be 2019-07-09 stsp .Cm cherrypick .
840 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
841 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
843 5ef14e63 2019-06-02 stsp into the work tree.
844 5ef14e63 2019-06-02 stsp The specified
846 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
847 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
848 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
849 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
851 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
852 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
853 5ef14e63 2019-06-02 stsp .It G Ta file was merged
854 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
855 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
856 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
857 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
858 5ef14e63 2019-06-02 stsp .It A Ta new file was added
859 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
862 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
863 5ef14e63 2019-06-02 stsp which may be viewed with
864 5ef14e63 2019-06-02 stsp .Cm got diff ,
865 5ef14e63 2019-06-02 stsp amended manually or with further
866 778a73c2 2019-07-12 stsp .Cm got backout
868 5ef14e63 2019-06-02 stsp committed with
869 5ef14e63 2019-06-02 stsp .Cm got commit ,
870 5ef14e63 2019-06-02 stsp or discarded again with
871 5ef14e63 2019-06-02 stsp .Cm got revert .
873 92228c38 2019-06-02 stsp .Cm got backout
874 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
875 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
876 92228c38 2019-06-02 stsp to a single base commit with
877 92228c38 2019-06-02 stsp .Cm got update .
878 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
879 92228c38 2019-06-02 stsp conflicts must be resolved first.
881 97b3a7be 2019-07-09 stsp Short alias for
882 97b3a7be 2019-07-09 stsp .Cm backout .
883 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
884 818c7501 2019-07-11 stsp Rebase commits on the specified
886 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
889 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
890 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
891 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
893 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
894 f09e2405 2019-07-11 stsp of the specified
896 f09e2405 2019-07-11 stsp has been rebased.
898 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
899 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
900 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
901 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
902 818c7501 2019-07-11 stsp .Ar branch ,
903 818c7501 2019-07-11 stsp but with different commit IDs.
904 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
905 f09e2405 2019-07-11 stsp the new version of the specified
907 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
909 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
910 818c7501 2019-07-11 stsp using the following status codes:
911 818c7501 2019-07-11 stsp .Bl -column YXZ description
912 818c7501 2019-07-11 stsp .It G Ta file was merged
913 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
914 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
915 818c7501 2019-07-11 stsp .It D Ta file was deleted
916 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
917 818c7501 2019-07-11 stsp .It A Ta new file was added
918 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
921 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
922 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
923 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
925 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
927 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
928 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
929 f09e2405 2019-07-11 stsp when the rebase operation continues.
931 818c7501 2019-07-11 stsp .Cm got rebase
932 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
933 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
934 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
935 818c7501 2019-07-11 stsp .Cm got update .
936 4ed9f614 2019-08-04 stsp If changes have been staged with
937 4ed9f614 2019-08-04 stsp .Cm got stage ,
938 bc3056e3 2019-08-18 stsp these changes must first be committed with
939 4ed9f614 2019-08-04 stsp .Cm got commit
940 4ed9f614 2019-08-04 stsp or unstaged with
941 4ed9f614 2019-08-04 stsp .Cm got unstage .
942 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
943 f09e2405 2019-07-11 stsp committed with
944 f09e2405 2019-07-11 stsp .Cm got commit
945 f09e2405 2019-07-11 stsp or reverted with
946 f09e2405 2019-07-11 stsp .Cm got revert .
949 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
950 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
953 7d5807f4 2019-07-11 stsp .Cm got update
955 7d5807f4 2019-07-11 stsp .Cm got commit
956 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
957 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
958 7d5807f4 2019-07-11 stsp conflict resolution purposes.
960 818c7501 2019-07-11 stsp The options for
961 818c7501 2019-07-11 stsp .Cm got rebase
962 818c7501 2019-07-11 stsp are as follows:
963 818c7501 2019-07-11 stsp .Bl -tag -width Ds
965 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
966 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
968 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
969 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
972 818c7501 2019-07-11 stsp Short alias for
973 818c7501 2019-07-11 stsp .Cm rebase .
974 dfc23429 2019-08-11 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
975 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
976 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
978 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
979 0ebf8283 2019-07-24 stsp .Ar histedit script
980 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
981 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
982 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
983 0ebf8283 2019-07-24 stsp whitespace and an argument.
984 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
985 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
986 0ebf8283 2019-07-24 stsp Lines which begin with the
988 0ebf8283 2019-07-24 stsp character are ignored entirely.
990 0ebf8283 2019-07-24 stsp The available commands are as follows:
991 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
992 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
993 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
994 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
995 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
996 0ebf8283 2019-07-24 stsp listed further below that will be used.
997 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
998 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
999 0ebf8283 2019-07-24 stsp the commit on the previous line.
1000 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1001 0ebf8283 2019-07-24 stsp log message can be written.
1004 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1005 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1007 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1008 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1009 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1010 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1011 498a90b7 2019-07-25 stsp switched to it.
1013 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1014 0ebf8283 2019-07-24 stsp using the following status codes:
1015 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1016 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1017 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1018 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1019 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1020 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1021 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1022 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1025 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1026 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1027 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1028 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1030 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1031 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1032 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1034 0ebf8283 2019-07-24 stsp .Cm got histedit
1035 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1036 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1037 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1038 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1039 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1040 0ebf8283 2019-07-24 stsp to a single base commit with
1041 0ebf8283 2019-07-24 stsp .Cm got update .
1042 4ed9f614 2019-08-04 stsp If changes have been staged with
1043 4ed9f614 2019-08-04 stsp .Cm got stage ,
1044 bc3056e3 2019-08-18 stsp these changes must first be committed with
1045 4ed9f614 2019-08-04 stsp .Cm got commit
1046 4ed9f614 2019-08-04 stsp or unstaged with
1047 4ed9f614 2019-08-04 stsp .Cm got unstage .
1048 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1049 0ebf8283 2019-07-24 stsp committed with
1050 0ebf8283 2019-07-24 stsp .Cm got commit
1051 0ebf8283 2019-07-24 stsp or reverted with
1052 0ebf8283 2019-07-24 stsp .Cm got revert .
1053 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1054 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1057 0ebf8283 2019-07-24 stsp .Cm got update
1058 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
1059 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1060 0ebf8283 2019-07-24 stsp .Cm got commit
1061 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1062 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1064 0ebf8283 2019-07-24 stsp The options for
1065 0ebf8283 2019-07-24 stsp .Cm got histedit
1066 0ebf8283 2019-07-24 stsp are as follows:
1067 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1069 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1070 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1072 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1073 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1076 0ebf8283 2019-07-24 stsp Short alias for
1077 0ebf8283 2019-07-24 stsp .Cm histedit .
1078 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1079 2822a352 2019-10-15 stsp Integrate the specified
1080 2822a352 2019-10-15 stsp .Ar branch
1081 2822a352 2019-10-15 stsp into the work tree's current branch.
1082 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1083 2822a352 2019-10-15 stsp .Ar branch ,
1084 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1085 2822a352 2019-10-15 stsp head commit of the integrated
1086 2822a352 2019-10-15 stsp .Ar branch .
1088 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1089 2822a352 2019-10-15 stsp will be pointing at the same commit.
1090 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1091 2822a352 2019-10-15 stsp In case the integrated
1092 2822a352 2019-10-15 stsp .Ar branch
1093 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1094 2822a352 2019-10-15 stsp .Cm got branch -d .
1096 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1097 2822a352 2019-10-15 stsp .Bl -column YXZ description
1098 2822a352 2019-10-15 stsp .It U Ta file was updated
1099 2822a352 2019-10-15 stsp .It D Ta file was deleted
1100 2822a352 2019-10-15 stsp .It A Ta new file was added
1101 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1102 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1105 2822a352 2019-10-15 stsp .Cm got integrate
1106 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1107 2822a352 2019-10-15 stsp Most importantly, the
1108 2822a352 2019-10-15 stsp .Ar branch
1109 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1110 2822a352 2019-10-15 stsp .Cm got rebase
1111 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1112 2822a352 2019-10-15 stsp resolve merge conflicts.
1113 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1114 2822a352 2019-10-15 stsp to a single base commit with
1115 2822a352 2019-10-15 stsp .Cm got update .
1116 2822a352 2019-10-15 stsp If changes have been staged with
1117 2822a352 2019-10-15 stsp .Cm got stage ,
1118 2822a352 2019-10-15 stsp these changes must first be committed with
1119 2822a352 2019-10-15 stsp .Cm got commit
1120 2822a352 2019-10-15 stsp or unstaged with
1121 2822a352 2019-10-15 stsp .Cm got unstage .
1122 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1123 2822a352 2019-10-15 stsp committed with
1124 2822a352 2019-10-15 stsp .Cm got commit
1125 2822a352 2019-10-15 stsp or reverted with
1126 2822a352 2019-10-15 stsp .Cm got revert .
1128 2822a352 2019-10-15 stsp Short alias for
1129 2822a352 2019-10-15 stsp .Cm integrate .
1130 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 ...
1131 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1134 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1135 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1136 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1137 4ed9f614 2019-08-04 stsp .Cm got status .
1139 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1140 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1141 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1142 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1143 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1146 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1147 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1148 9d8b19a4 2019-08-04 stsp committed.
1150 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1151 4ed9f614 2019-08-04 stsp .Cm got commit ,
1152 4ed9f614 2019-08-04 stsp .Cm got status ,
1154 4ed9f614 2019-08-04 stsp .Cm got diff .
1155 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1156 4ed9f614 2019-08-04 stsp .Cm got commit
1157 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1158 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1159 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1161 4ed9f614 2019-08-04 stsp .Cm got status
1162 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1164 4ed9f614 2019-08-04 stsp .Cm got diff
1165 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1166 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1168 4ed9f614 2019-08-04 stsp .Cm got revert
1169 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1170 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1172 4ed9f614 2019-08-04 stsp The options for
1173 4ed9f614 2019-08-04 stsp .Cm got stage
1174 4ed9f614 2019-08-04 stsp are as follows:
1175 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1177 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1178 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1179 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1180 1dd86744 2019-08-12 anthony among the specified paths.
1181 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1183 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1184 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1186 6d23ec10 2019-08-08 stsp (stage change),
1188 6d23ec10 2019-08-08 stsp (reject change), and
1190 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1191 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1192 dc424a06 2019-08-07 stsp modified file content can be staged.
1193 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1194 6d23ec10 2019-08-08 stsp their entirety.
1195 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1198 3a070a2b 2019-08-07 stsp option, read
1203 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1204 0e2f5884 2019-08-07 stsp .Ar response-script
1205 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1208 4ed9f614 2019-08-04 stsp .Cm got stage
1209 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1210 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1211 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1212 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1213 4ed9f614 2019-08-04 stsp .Cm got update
1214 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1215 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1218 4ed9f614 2019-08-04 stsp .Cm got update ,
1219 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1221 4ed9f614 2019-08-04 stsp .Cm got histedit
1222 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1223 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1224 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1225 4ed9f614 2019-08-04 stsp .Cm got unstage
1226 4ed9f614 2019-08-04 stsp before it can be updated with
1227 4ed9f614 2019-08-04 stsp .Cm got update ,
1228 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1230 4ed9f614 2019-08-04 stsp Short alias for
1231 4ed9f614 2019-08-04 stsp .Cm stage .
1232 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1233 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1234 4ed9f614 2019-08-04 stsp back into non-staged status.
1237 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1238 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1240 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1241 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1242 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1243 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1244 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1245 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1246 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1247 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1250 2e1f37b0 2019-08-08 stsp The options for
1251 2e1f37b0 2019-08-08 stsp .Cm got unstage
1252 2e1f37b0 2019-08-08 stsp are as follows:
1253 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1255 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1256 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1258 2e1f37b0 2019-08-08 stsp (unstage change),
1260 2e1f37b0 2019-08-08 stsp (keep change staged), and
1262 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1263 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1264 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1265 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1266 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1269 2e1f37b0 2019-08-08 stsp option, read
1274 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1275 2e1f37b0 2019-08-08 stsp .Ar response-script
1276 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1279 4ed9f614 2019-08-04 stsp Short alias for
1280 4ed9f614 2019-08-04 stsp .Cm unstage .
1281 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 ...
1282 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1283 896e9b6f 2019-08-26 stsp text format.
1284 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1285 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1286 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1288 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1289 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1290 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1291 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1292 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1293 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1295 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1297 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1298 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1300 01073a5d 2019-08-22 stsp The options for
1301 01073a5d 2019-08-22 stsp .Cm got cat
1302 01073a5d 2019-08-22 stsp are as follows:
1303 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1304 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1305 896e9b6f 2019-08-26 stsp Look up paths in the specified
1306 896e9b6f 2019-08-26 stsp .Ar commit .
1307 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1308 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1309 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1310 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1311 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1312 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1313 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1314 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1315 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1316 01073a5d 2019-08-22 stsp working directory.
1317 01073a5d 2019-08-22 stsp If this directory is a
1319 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1321 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1322 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1323 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1326 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1327 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1328 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1329 74416c47 2019-05-09 stsp The author's name and email address for
1330 21a44f98 2019-07-15 stsp .Cm got commit
1332 21a44f98 2019-07-15 stsp .Cm got import ,
1333 74416c47 2019-05-09 stsp for example:
1334 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1337 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1339 84792843 2019-08-09 stsp attempts to reject
1340 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1341 84792843 2019-08-09 stsp environment variables with a missing email address.
1343 c9956ddf 2019-09-08 stsp If present, Git's
1344 aba9c984 2019-09-08 stsp .Dv user.name
1346 709ae9eb 2019-09-08 stsp .Dv user.email
1347 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1348 aba9c984 2019-09-08 stsp .Pa .git/config
1349 aba9c984 2019-09-08 stsp file will override the value of
1350 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1351 c9956ddf 2019-09-08 stsp However, the
1352 c9956ddf 2019-09-08 stsp .Dv user.name
1354 c9956ddf 2019-09-08 stsp .Dv user.email
1355 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1356 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1357 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1358 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1359 c9956ddf 2019-09-08 stsp environment variable is
1362 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1363 23594da9 2019-05-13 stsp The editor spawned by
1364 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1365 8e7bd50a 2019-08-22 stsp .Cm got import ,
1367 8e7bd50a 2019-08-22 stsp .Cm got tag .
1368 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1369 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1370 b1ebc001 2019-08-13 stsp .Cm got log .
1371 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1372 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1374 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1375 5c860e29 2018-03-12 stsp .Ex -std got
1376 97925469 2018-03-17 stsp .Sh EXAMPLES
1377 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1379 fa6e0e48 2019-05-23 stsp This step currently requires
1380 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1382 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1383 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1385 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1387 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1388 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1389 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1391 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1392 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1394 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1396 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1398 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1400 e70c17ce 2019-05-22 stsp .Dl $ got status
1401 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1403 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1405 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1407 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1409 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1411 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1412 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1413 d83d9d5c 2019-05-13 stsp which is forked off the
1414 d83d9d5c 2019-05-13 stsp .Dq master
1417 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1419 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1420 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1421 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1423 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1425 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1426 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1428 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1430 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1431 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1432 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1434 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
1436 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1438 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1439 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1441 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1442 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1444 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1446 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1447 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1448 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1450 95fc3404 2019-07-15 stsp .Dl $ got update
1452 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1453 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1454 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1456 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1457 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1458 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1459 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1461 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
1462 9221fb1e 2019-06-26 stsp This step currently requires
1463 9221fb1e 2019-06-26 stsp .Xr git 1 :
1465 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1466 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
1468 fa6e0e48 2019-05-23 stsp Rebase the
1469 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1470 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1471 fa6e0e48 2019-05-23 stsp .Dq master
1474 818c7501 2019-07-11 stsp .Dl $ got update -b master
1475 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1477 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1478 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1479 1dd86744 2019-08-12 anthony .Ox Ns 's
1480 1dd86744 2019-08-12 anthony CVS tree:
1482 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1484 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1485 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1488 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1489 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1490 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1492 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
1493 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1494 7b3fde24 2019-07-28 stsp .Cm git fetch
1496 7b3fde24 2019-07-28 stsp .Cm git push .
1497 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1498 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
1500 ff2cf171 2019-07-28 stsp .Dq refspec
1501 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1503 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1504 ff2cf171 2019-07-28 stsp namespace of the local repository.
1505 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1506 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1507 ff2cf171 2019-07-28 stsp configuration variable to the value
1508 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1510 ff2cf171 2019-07-28 stsp .Cm git config
1513 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1514 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1516 ff2cf171 2019-07-28 stsp Alternatively, the following
1518 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1519 ff2cf171 2019-07-28 stsp .Pa config
1522 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1523 ff2cf171 2019-07-28 stsp .Dl url = ...
1524 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1526 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1527 ff2cf171 2019-07-28 stsp .Dq refs/heads
1528 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1529 ff2cf171 2019-07-28 stsp .Cm got checkout
1530 ff2cf171 2019-07-28 stsp and, if needed, created with
1531 ff2cf171 2019-07-28 stsp .Cm got branch .
1533 ff2cf171 2019-07-28 stsp Branches in the
1534 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1535 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
1536 ff2cf171 2019-07-28 stsp repository with
1537 ff2cf171 2019-07-28 stsp .Cm git fetch :
1539 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1540 ff2cf171 2019-07-28 stsp .Dl $ git fetch
1542 ff2cf171 2019-07-28 stsp Before outgoing changes on the local
1543 ff2cf171 2019-07-28 stsp .Dq master
1544 ff2cf171 2019-07-28 stsp branch can be pushed to the remote repository, the local
1545 ff2cf171 2019-07-28 stsp .Dq master
1546 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1547 ff2cf171 2019-07-28 stsp .Dq origin/master
1550 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1551 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1553 ff2cf171 2019-07-28 stsp Changes on the local
1554 ff2cf171 2019-07-28 stsp .Dq master
1555 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1556 ff2cf171 2019-07-28 stsp repository with
1557 ff2cf171 2019-07-28 stsp .Cm git push :
1559 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1560 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1562 14c25ea2 2019-10-15 stsp In order to merge changes committed to the
1563 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1564 14c25ea2 2019-10-15 stsp branch back into the
1565 14c25ea2 2019-10-15 stsp .Dq master
1566 14c25ea2 2019-10-15 stsp branch, the
1567 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1568 14c25ea2 2019-10-15 stsp branch must first be rebased onto the
1569 14c25ea2 2019-10-15 stsp .Dq master
1572 14c25ea2 2019-10-15 stsp .Dl $ got update -b master
1573 14c25ea2 2019-10-15 stsp .Dl $ got rebase unified-buffer-cache
1575 14c25ea2 2019-10-15 stsp Changes on the
1576 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1577 14c25ea2 2019-10-15 stsp branch can now be made visible on the
1578 14c25ea2 2019-10-15 stsp .Dq master
1579 14c25ea2 2019-10-15 stsp branch with
1580 14c25ea2 2019-10-15 stsp .Cm got integrate .
1581 14c25ea2 2019-10-15 stsp Because the rebase operation switched the work tree to the
1582 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1583 14c25ea2 2019-10-15 stsp branch, the work tree must be switched back to the
1584 14c25ea2 2019-10-15 stsp .Dq master
1585 14c25ea2 2019-10-15 stsp branch before the
1586 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1587 14c25ea2 2019-10-15 stsp branch can be integrated into
1588 14c25ea2 2019-10-15 stsp .Dq master :
1590 14c25ea2 2019-10-15 stsp .Dl $ got update -b master
1591 14c25ea2 2019-10-15 stsp .Dl $ got integrate unified-buffer-cache
1592 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1593 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1594 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1595 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1596 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1597 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1598 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1599 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1600 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1602 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1603 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1605 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1606 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
