2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5d56da81 2019-01-13 stsp .\" Copyright (c) 2018, 2019 Stefan Sperling
5 5c860e29 2018-03-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
6 5c860e29 2018-03-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
7 5c860e29 2018-03-12 stsp .\" copyright notice and this permission notice appear in all copies.
9 5c860e29 2018-03-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 5c860e29 2018-03-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 5c860e29 2018-03-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 5c860e29 2018-03-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 5c860e29 2018-03-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 5c860e29 2018-03-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 5c860e29 2018-03-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 5c860e29 2018-03-12 stsp .Dd $Mdocdate$
22 8e13c46f 2019-08-05 stsp .Nd Game of Trees
23 5c860e29 2018-03-12 stsp .Sh SYNOPSIS
27 5c860e29 2018-03-12 stsp .Op Ar arg ...
28 5c860e29 2018-03-12 stsp .Sh DESCRIPTION
30 4dfb2f0f 2019-03-26 stsp is a version control system which stores the history of tracked files
31 4dfb2f0f 2019-03-26 stsp in a Git repository, as used by the Git version control system.
32 285dc8a4 2018-03-13 stsp This repository format is described in
33 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
37 ae73e26f 2019-03-26 stsp .Dq distributed
38 4129c201 2018-03-13 stsp version control system because every copy of a repository is writeable.
39 4129c201 2018-03-13 stsp Modifications made to files can be synchronized between repositories
40 97925469 2018-03-17 stsp at any time.
42 285dc8a4 2018-03-13 stsp Files managed by
44 4129c201 2018-03-13 stsp must be checked out from the repository for modification.
45 285dc8a4 2018-03-13 stsp Checked out files are stored in a
46 285dc8a4 2018-03-13 stsp .Em work tree
47 c5867b47 2018-03-13 stsp which can be placed at an arbitrary directory in the filesystem hierarchy.
48 fb2921d0 2019-03-26 stsp The on-disk format of this work tree is described in
49 285dc8a4 2018-03-13 stsp .Xr got-worktree 5 .
52 285dc8a4 2018-03-13 stsp provides global and command-specific options.
53 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
112 3ce1b845 2019-07-15 stsp .Dq master .
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 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
257 2a06fe5f 2019-08-24 stsp specified on the command line
262 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
263 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
265 4ed9f614 2019-08-04 stsp If changes have been staged with
266 4ed9f614 2019-08-04 stsp .Cm got stage ,
267 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
268 4ed9f614 2019-08-04 stsp status codes:
269 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
270 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
271 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
272 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
275 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
276 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
277 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
278 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
281 6841da00 2019-08-08 stsp For compatibility with
284 bd8de430 2019-10-04 stsp .Xr git 1 ,
285 6841da00 2019-08-08 stsp .Cm got status
288 bd8de430 2019-10-04 stsp patterns from
289 6841da00 2019-08-08 stsp .Pa .cvsignore
291 bd8de430 2019-10-04 stsp .Pa .gitignore
292 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
293 bd8de430 2019-10-04 stsp which match these patterns.
294 bd8de430 2019-10-04 stsp As an extension to
296 bd8de430 2019-10-04 stsp matching rules,
297 bd8de430 2019-10-04 stsp .Cm got status
298 bd8de430 2019-10-04 stsp supports consecutive asterisks,
300 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
302 6841da00 2019-08-08 stsp .Xr cvs 1 ,
303 6841da00 2019-08-08 stsp .Cm got status
304 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
306 bd8de430 2019-10-04 stsp .Xr git 1 ,
307 bd8de430 2019-10-04 stsp .Cm got status
308 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
310 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
312 bd8de430 2019-10-04 stsp in a pattern.
314 97b3a7be 2019-07-09 stsp Short alias for
315 97b3a7be 2019-07-09 stsp .Cm status .
316 dfc23429 2019-08-11 stsp .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 r Ar repository-path Oc Op Ar path
317 38e11793 2018-06-13 stsp Display history of a repository.
320 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
322 38e11793 2018-06-13 stsp The options for
323 38e11793 2018-06-13 stsp .Cm got log
324 38e11793 2018-06-13 stsp are as follows:
325 38e11793 2018-06-13 stsp .Bl -tag -width Ds
326 38e11793 2018-06-13 stsp .It Fl c Ar commit
327 38e11793 2018-06-13 stsp Start traversing history at the specified
328 38e11793 2018-06-13 stsp .Ar commit .
329 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
330 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
331 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
332 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
333 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
334 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
335 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
336 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
338 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
340 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
341 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
342 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
343 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
344 6238ee32 2018-06-13 stsp .It Fl l Ar N
345 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
346 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
347 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
349 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
350 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
352 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
355 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
356 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
357 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
358 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
359 04ca23f4 2018-07-16 stsp working directory.
360 e9cf2e30 2019-02-05 stsp If this directory is a
362 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
364 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
365 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
366 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
369 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
371 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
372 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
373 d24820bf 2019-08-11 stsp corresponding objects.
374 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
375 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
376 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
378 c0cc5c62 2018-10-18 stsp The options for
379 c0cc5c62 2018-10-18 stsp .Cm got diff
380 c0cc5c62 2018-10-18 stsp are as follows:
381 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
382 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
383 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
384 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
385 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
386 b72f483a 2019-02-05 stsp Use the repository at the specified path.
387 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
388 b72f483a 2019-02-05 stsp working directory.
389 b72f483a 2019-02-05 stsp If this directory is a
391 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
393 4ed9f614 2019-08-04 stsp Show changes staged with
394 4ed9f614 2019-08-04 stsp .Cm got stage
395 4ed9f614 2019-08-04 stsp instead of showing local changes.
396 4ed9f614 2019-08-04 stsp This option is only valid when
397 4ed9f614 2019-08-04 stsp .Cm got diff
398 4ed9f614 2019-08-04 stsp is invoked in a work tree.
400 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
403 bc26cce8 2019-08-04 stsp Short alias for
405 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
406 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
408 1ff8e573 2018-08-02 stsp The options for
409 1ff8e573 2018-08-02 stsp .Cm got blame
410 1ff8e573 2018-08-02 stsp are as follows:
411 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
412 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
413 1ff8e573 2018-08-02 stsp Start traversing history at the specified
414 1ff8e573 2018-08-02 stsp .Ar commit .
415 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
416 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
417 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
418 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
419 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
420 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
421 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
422 1ff8e573 2018-08-02 stsp working directory.
423 0c06baac 2019-02-05 stsp If this directory is a
425 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
428 bc26cce8 2019-08-04 stsp Short alias for
429 bc26cce8 2019-08-04 stsp .Cm blame .
430 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
431 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
432 5de5890b 2018-10-18 stsp directory path in the repository.
433 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
434 db0c2996 2019-02-10 stsp annotations:
435 db0c2996 2019-02-10 stsp .Bl -column YXZ description
436 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
437 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
438 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
439 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
444 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
445 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
446 0c849583 2019-02-05 stsp if there is no work tree.
448 5de5890b 2018-10-18 stsp The options for
449 5de5890b 2018-10-18 stsp .Cm got tree
450 5de5890b 2018-10-18 stsp are as follows:
451 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
452 5de5890b 2018-10-18 stsp .It Fl c Ar commit
453 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
454 5de5890b 2018-10-18 stsp .Ar commit .
455 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
456 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
457 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
458 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
459 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
460 5de5890b 2018-10-18 stsp Use the repository at the specified path.
461 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
462 5de5890b 2018-10-18 stsp working directory.
463 0c849583 2019-02-05 stsp If this directory is a
465 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
467 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
469 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
472 bc26cce8 2019-08-04 stsp Short alias for
474 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
475 d0eebce4 2019-03-11 stsp Manage references in a repository.
477 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
478 d0eebce4 2019-03-11 stsp or update, the reference with the given
480 d0eebce4 2019-03-11 stsp and make it point at the given
481 d83d9d5c 2019-05-13 stsp .Ar target .
482 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
483 f16e4044 2019-10-09 stsp .Dq refs/ .
484 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
485 a54b6686 2019-06-28 stsp will be resolved to an object ID.
486 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
487 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
489 d0eebce4 2019-03-11 stsp The options for
490 d0eebce4 2019-03-11 stsp .Cm got ref
491 d0eebce4 2019-03-11 stsp are as follows:
492 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
493 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
494 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
495 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
496 d0eebce4 2019-03-11 stsp working directory.
497 d0eebce4 2019-03-11 stsp If this directory is a
499 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
501 d0eebce4 2019-03-11 stsp List all existing references in the repository.
502 d0eebce4 2019-03-11 stsp .It Fl d Ar name
503 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
505 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
506 d1c1ae5f 2019-08-12 stsp .Ar target ,
507 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
508 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
509 d1c1ae5f 2019-08-12 stsp this option is used.
511 a4f89d48 2019-08-25 stsp .It Cm branch Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Op Ar name Op Ar commit
512 4e759de4 2019-06-26 stsp Manage branches in a repository.
514 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
515 4e759de4 2019-06-26 stsp .Dq refs/heads/
516 4e759de4 2019-06-26 stsp reference namespace.
518 4e759de4 2019-06-26 stsp .Cm got branch
519 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
521 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
522 ad89fa31 2019-10-04 stsp work tree's current branch.
523 ba6e0c2d 2019-10-04 stsp If one or two arguments are passed, attempt to create a branch reference
524 ba6e0c2d 2019-10-04 stsp with the given
526 4e759de4 2019-06-26 stsp and make it point at the given
527 a4f89d48 2019-08-25 stsp .Ar commit .
528 a4f89d48 2019-08-25 stsp The expected
530 a4f89d48 2019-08-25 stsp argument is a commit ID SHA1 hash or an existing reference
531 a4f89d48 2019-08-25 stsp or tag name which will be resolved to a commit ID.
534 a4f89d48 2019-08-25 stsp is specified, default to the latest commit on the work tree's current
535 a4f89d48 2019-08-25 stsp branch if invoked in a work tree, or to a commit resolved via the
536 a4f89d48 2019-08-25 stsp repository's HEAD reference.
538 4e759de4 2019-06-26 stsp The options for
539 4e759de4 2019-06-26 stsp .Cm got branch
540 4e759de4 2019-06-26 stsp are as follows:
541 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
542 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
543 4e759de4 2019-06-26 stsp Use the repository at the specified path.
544 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
545 4e759de4 2019-06-26 stsp working directory.
546 4e759de4 2019-06-26 stsp If this directory is a
548 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
550 4e759de4 2019-06-26 stsp List all existing branches in the repository.
551 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
552 ba882ee3 2019-07-11 stsp with one the following annotations:
553 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
554 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
555 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
557 4e759de4 2019-06-26 stsp .It Fl d Ar name
558 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
559 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
560 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
561 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
562 ce33d90e 2019-07-14 stsp Git's garbage collector.
565 97b3a7be 2019-07-09 stsp Short alias for
566 97b3a7be 2019-07-09 stsp .Cm branch .
567 8e7bd50a 2019-08-22 stsp .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 Oc
568 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
570 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
571 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
572 8e7bd50a 2019-08-22 stsp reference namespace.
574 8e7bd50a 2019-08-22 stsp .Cm got tag
575 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
576 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
577 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
579 8e7bd50a 2019-08-22 stsp Expect one or two arguments and attempt to create a tag with the given
581 8e7bd50a 2019-08-22 stsp and make this tag point at the given
582 8e7bd50a 2019-08-22 stsp .Ar commit .
583 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
584 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
585 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
586 8e7bd50a 2019-08-22 stsp Otherwise, the expected argument is a commit ID SHA1 hash or an existing
587 8e7bd50a 2019-08-22 stsp reference or tag name which will be resolved to a commit ID.
588 8e7bd50a 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
589 8e7bd50a 2019-08-22 stsp automatically, provided the abbreviation is unique.
591 8e7bd50a 2019-08-22 stsp The options for
592 8e7bd50a 2019-08-22 stsp .Cm got tag
593 8e7bd50a 2019-08-22 stsp are as follows:
594 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
595 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
596 8e7bd50a 2019-08-22 stsp Use the specified tag message when creating the new tag
597 8e7bd50a 2019-08-22 stsp Without the
600 8e7bd50a 2019-08-22 stsp .Cm got import
601 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
602 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
603 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
604 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
605 8e7bd50a 2019-08-22 stsp working directory.
606 8e7bd50a 2019-08-22 stsp If this directory is a
608 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
610 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
611 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
614 8e7bd50a 2019-08-22 stsp By design, the
615 8e7bd50a 2019-08-22 stsp .Cm got tag
616 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
617 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
618 8e7bd50a 2019-08-22 stsp .Cm got ref
619 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
620 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
621 8e7bd50a 2019-08-22 stsp another repository.
622 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
623 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
624 d00136be 2019-03-26 stsp repository in the next commit.
625 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
626 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
627 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
629 2ec1f75b 2019-03-26 stsp The options for
630 86d25a1b 2019-07-11 stsp .Cm got remove
631 2ec1f75b 2019-03-26 stsp are as follows:
632 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
634 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
637 648e4ef7 2019-07-09 stsp Short alias for
638 648e4ef7 2019-07-09 stsp .Cm remove .
639 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 ...
640 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
641 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
642 1dd86744 2019-08-12 anthony work tree's base commit.
643 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
644 a129376b 2019-03-28 stsp .Cm got revert !
646 e20a8b6f 2019-06-04 stsp If a file was added with
647 a129376b 2019-03-28 stsp .Cm got add
648 a129376b 2019-03-28 stsp it will become an unversioned file again.
649 e20a8b6f 2019-06-04 stsp If a file was deleted with
650 86d25a1b 2019-07-11 stsp .Cm got remove
651 a129376b 2019-03-28 stsp it will be restored.
653 0f6d7415 2019-08-08 stsp The options for
654 0f6d7415 2019-08-08 stsp .Cm got revert
655 0f6d7415 2019-08-08 stsp are as follows:
656 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
658 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
659 33aa809d 2019-08-08 stsp changes to revert based on
661 33aa809d 2019-08-08 stsp (revert change),
663 33aa809d 2019-08-08 stsp (keep change), and
665 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
666 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
667 33aa809d 2019-08-08 stsp modified file content can be reverted.
668 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
669 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
672 33aa809d 2019-08-08 stsp option, read
677 33aa809d 2019-08-08 stsp responses line-by-line from the specified
678 33aa809d 2019-08-08 stsp .Ar response-script
679 33aa809d 2019-08-08 stsp file instead of prompting interactively.
681 0f6d7415 2019-08-08 stsp Permit recursion into directories.
682 0f6d7415 2019-08-08 stsp If this option is not specified,
683 0f6d7415 2019-08-08 stsp .Cm got revert
684 0f6d7415 2019-08-08 stsp will refuse to run if a specified
686 0f6d7415 2019-08-08 stsp is a directory.
689 97b3a7be 2019-07-09 stsp Short alias for
690 97b3a7be 2019-07-09 stsp .Cm revert .
691 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
692 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
693 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
696 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
697 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
699 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
700 1dd86744 2019-08-12 anthony .Cm got stage ,
701 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
702 4ed9f614 2019-08-04 stsp have not been staged.
704 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
705 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
706 15cd91f7 2019-05-12 stsp .It M Ta modified file
707 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
708 15cd91f7 2019-05-12 stsp .It A Ta new file was added
711 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
712 996d5ccd 2019-08-05 stsp recorded base commit.
715 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
716 15cd91f7 2019-05-12 stsp multiple base commits.
717 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
718 47ec7be7 2019-05-12 stsp .Cm got update
719 47ec7be7 2019-05-12 stsp across the entire work tree.
722 15cd91f7 2019-05-12 stsp .Cm got commit
723 15cd91f7 2019-05-12 stsp command requires the
724 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
725 aba9c984 2019-09-08 stsp environment variable to be set,
726 aba9c984 2019-09-08 stsp unless Git's
727 aba9c984 2019-09-08 stsp .Dv user.name
729 709ae9eb 2019-09-08 stsp .Dv user.email
730 709ae9eb 2019-09-08 stsp configuration settings can be
731 aba9c984 2019-09-08 stsp obtained from the repository's
732 aba9c984 2019-09-08 stsp .Pa .git/config
733 c9956ddf 2019-09-08 stsp file or from Git's global
734 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
735 c9956ddf 2019-09-08 stsp configuration file.
737 74416c47 2019-05-09 stsp The options for
738 74416c47 2019-05-09 stsp .Cm got commit
739 74416c47 2019-05-09 stsp are as follows:
740 74416c47 2019-05-09 stsp .Bl -tag -width Ds
741 74ff3f23 2019-07-07 stsp .It Fl m Ar message
742 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
743 23594da9 2019-05-13 stsp Without the
746 23594da9 2019-05-13 stsp .Cm got commit
747 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
750 cfce0458 2019-07-28 stsp .Cm got commit
751 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
752 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
753 916f288c 2019-07-30 stsp .Dq refs/heads/
754 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
755 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
756 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
757 cfce0458 2019-07-28 stsp If a path is found to be out of date,
758 cfce0458 2019-07-28 stsp .Cm got update
759 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
760 cfce0458 2019-07-28 stsp in the repository.
762 97b3a7be 2019-07-09 stsp Short alias for
763 97b3a7be 2019-07-09 stsp .Cm commit .
764 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
765 234035bc 2019-06-01 stsp Merge changes from a single
767 234035bc 2019-06-01 stsp into the work tree.
768 234035bc 2019-06-01 stsp The specified
770 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
771 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
772 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
773 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
775 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
776 234035bc 2019-06-01 stsp .Bl -column YXZ description
777 234035bc 2019-06-01 stsp .It G Ta file was merged
778 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
779 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
780 234035bc 2019-06-01 stsp .It D Ta file was deleted
781 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
782 234035bc 2019-06-01 stsp .It A Ta new file was added
783 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
786 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
787 234035bc 2019-06-01 stsp may be viewed with
788 234035bc 2019-06-01 stsp .Cm got diff ,
789 234035bc 2019-06-01 stsp amended manually or with further
790 234035bc 2019-06-01 stsp .Cm got cherrypick
792 234035bc 2019-06-01 stsp committed with
793 234035bc 2019-06-01 stsp .Cm got commit ,
794 234035bc 2019-06-01 stsp or discarded again with
795 234035bc 2019-06-01 stsp .Cm got revert .
797 234035bc 2019-06-01 stsp .Cm got cherrypick
798 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
799 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
800 234035bc 2019-06-01 stsp to a single base commit with
801 234035bc 2019-06-01 stsp .Cm got update .
802 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
803 234035bc 2019-06-01 stsp conflicts must be resolved first.
805 97b3a7be 2019-07-09 stsp Short alias for
806 97b3a7be 2019-07-09 stsp .Cm cherrypick .
807 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
808 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
810 5ef14e63 2019-06-02 stsp into the work tree.
811 5ef14e63 2019-06-02 stsp The specified
813 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
814 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
815 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
816 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
818 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
819 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
820 5ef14e63 2019-06-02 stsp .It G Ta file was merged
821 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
822 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
823 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
824 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
825 5ef14e63 2019-06-02 stsp .It A Ta new file was added
826 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
829 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
830 5ef14e63 2019-06-02 stsp which may be viewed with
831 5ef14e63 2019-06-02 stsp .Cm got diff ,
832 5ef14e63 2019-06-02 stsp amended manually or with further
833 778a73c2 2019-07-12 stsp .Cm got backout
835 5ef14e63 2019-06-02 stsp committed with
836 5ef14e63 2019-06-02 stsp .Cm got commit ,
837 5ef14e63 2019-06-02 stsp or discarded again with
838 5ef14e63 2019-06-02 stsp .Cm got revert .
840 92228c38 2019-06-02 stsp .Cm got backout
841 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
842 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
843 92228c38 2019-06-02 stsp to a single base commit with
844 92228c38 2019-06-02 stsp .Cm got update .
845 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
846 92228c38 2019-06-02 stsp conflicts must be resolved first.
848 97b3a7be 2019-07-09 stsp Short alias for
849 97b3a7be 2019-07-09 stsp .Cm backout .
850 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
851 818c7501 2019-07-11 stsp Rebase commits on the specified
853 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
856 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
857 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
858 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
860 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
861 f09e2405 2019-07-11 stsp of the specified
863 f09e2405 2019-07-11 stsp has been rebased.
865 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
866 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
867 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
868 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
869 818c7501 2019-07-11 stsp .Ar branch ,
870 818c7501 2019-07-11 stsp but with different commit IDs.
871 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
872 f09e2405 2019-07-11 stsp the new version of the specified
874 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
876 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
877 818c7501 2019-07-11 stsp using the following status codes:
878 818c7501 2019-07-11 stsp .Bl -column YXZ description
879 818c7501 2019-07-11 stsp .It G Ta file was merged
880 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
881 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
882 818c7501 2019-07-11 stsp .It D Ta file was deleted
883 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
884 818c7501 2019-07-11 stsp .It A Ta new file was added
885 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
888 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
889 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
890 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
892 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
894 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
895 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
896 f09e2405 2019-07-11 stsp when the rebase operation continues.
898 818c7501 2019-07-11 stsp .Cm got rebase
899 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
900 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
901 818c7501 2019-07-11 stsp to a single base commit with
902 818c7501 2019-07-11 stsp .Cm got update .
903 4ed9f614 2019-08-04 stsp If changes have been staged with
904 4ed9f614 2019-08-04 stsp .Cm got stage ,
905 bc3056e3 2019-08-18 stsp these changes must first be committed with
906 4ed9f614 2019-08-04 stsp .Cm got commit
907 4ed9f614 2019-08-04 stsp or unstaged with
908 4ed9f614 2019-08-04 stsp .Cm got unstage .
909 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
910 f09e2405 2019-07-11 stsp committed with
911 f09e2405 2019-07-11 stsp .Cm got commit
912 f09e2405 2019-07-11 stsp or reverted with
913 f09e2405 2019-07-11 stsp .Cm got revert .
916 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
917 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
920 7d5807f4 2019-07-11 stsp .Cm got update
922 7d5807f4 2019-07-11 stsp .Cm got commit
923 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
924 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
925 7d5807f4 2019-07-11 stsp conflict resolution purposes.
927 818c7501 2019-07-11 stsp The options for
928 818c7501 2019-07-11 stsp .Cm got rebase
929 818c7501 2019-07-11 stsp are as follows:
930 818c7501 2019-07-11 stsp .Bl -tag -width Ds
932 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
933 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
935 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
936 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
939 818c7501 2019-07-11 stsp Short alias for
940 818c7501 2019-07-11 stsp .Cm rebase .
941 dfc23429 2019-08-11 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
942 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
943 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
945 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
946 0ebf8283 2019-07-24 stsp .Ar histedit script
947 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
948 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
949 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
950 0ebf8283 2019-07-24 stsp whitespace and an argument.
951 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
952 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
953 0ebf8283 2019-07-24 stsp Lines which begin with the
955 0ebf8283 2019-07-24 stsp character are ignored entirely.
957 0ebf8283 2019-07-24 stsp The available commands are as follows:
958 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
959 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
960 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
961 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
962 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
963 0ebf8283 2019-07-24 stsp listed further below that will be used.
964 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
965 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
966 0ebf8283 2019-07-24 stsp the commit on the previous line.
967 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
968 0ebf8283 2019-07-24 stsp log message can be written.
971 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
972 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
974 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
975 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
976 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
977 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
978 498a90b7 2019-07-25 stsp switched to it.
980 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
981 0ebf8283 2019-07-24 stsp using the following status codes:
982 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
983 0ebf8283 2019-07-24 stsp .It G Ta file was merged
984 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
985 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
986 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
987 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
988 0ebf8283 2019-07-24 stsp .It A Ta new file was added
989 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
992 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
993 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
994 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
995 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
997 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
998 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
999 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1001 0ebf8283 2019-07-24 stsp .Cm got histedit
1002 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1003 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1004 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1005 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1006 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1007 0ebf8283 2019-07-24 stsp to a single base commit with
1008 0ebf8283 2019-07-24 stsp .Cm got update .
1009 4ed9f614 2019-08-04 stsp If changes have been staged with
1010 4ed9f614 2019-08-04 stsp .Cm got stage ,
1011 bc3056e3 2019-08-18 stsp these changes must first be committed with
1012 4ed9f614 2019-08-04 stsp .Cm got commit
1013 4ed9f614 2019-08-04 stsp or unstaged with
1014 4ed9f614 2019-08-04 stsp .Cm got unstage .
1015 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1016 0ebf8283 2019-07-24 stsp committed with
1017 0ebf8283 2019-07-24 stsp .Cm got commit
1018 0ebf8283 2019-07-24 stsp or reverted with
1019 0ebf8283 2019-07-24 stsp .Cm got revert .
1020 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1021 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1024 0ebf8283 2019-07-24 stsp .Cm got update
1025 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
1026 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1027 0ebf8283 2019-07-24 stsp .Cm got commit
1028 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1029 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1031 0ebf8283 2019-07-24 stsp The options for
1032 0ebf8283 2019-07-24 stsp .Cm got histedit
1033 0ebf8283 2019-07-24 stsp are as follows:
1034 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1036 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1037 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1039 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1040 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1043 0ebf8283 2019-07-24 stsp Short alias for
1044 0ebf8283 2019-07-24 stsp .Cm histedit .
1045 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 ...
1046 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1049 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1050 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1051 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1052 4ed9f614 2019-08-04 stsp .Cm got status .
1054 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1055 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1056 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1057 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1058 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1061 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1062 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1063 9d8b19a4 2019-08-04 stsp committed.
1065 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1066 4ed9f614 2019-08-04 stsp .Cm got commit ,
1067 4ed9f614 2019-08-04 stsp .Cm got status ,
1069 4ed9f614 2019-08-04 stsp .Cm got diff .
1070 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1071 4ed9f614 2019-08-04 stsp .Cm got commit
1072 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1073 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1074 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1076 4ed9f614 2019-08-04 stsp .Cm got status
1077 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1079 4ed9f614 2019-08-04 stsp .Cm got diff
1080 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1081 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1083 4ed9f614 2019-08-04 stsp .Cm got revert
1084 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1085 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1087 4ed9f614 2019-08-04 stsp The options for
1088 4ed9f614 2019-08-04 stsp .Cm got stage
1089 4ed9f614 2019-08-04 stsp are as follows:
1090 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1092 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1093 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1094 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1095 1dd86744 2019-08-12 anthony among the specified paths.
1096 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1098 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1099 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1101 6d23ec10 2019-08-08 stsp (stage change),
1103 6d23ec10 2019-08-08 stsp (reject change), and
1105 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1106 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1107 dc424a06 2019-08-07 stsp modified file content can be staged.
1108 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1109 6d23ec10 2019-08-08 stsp their entirety.
1110 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1113 3a070a2b 2019-08-07 stsp option, read
1118 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1119 0e2f5884 2019-08-07 stsp .Ar response-script
1120 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1123 4ed9f614 2019-08-04 stsp .Cm got stage
1124 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1125 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1126 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1127 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1128 4ed9f614 2019-08-04 stsp .Cm got update
1129 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1130 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1133 4ed9f614 2019-08-04 stsp .Cm got update ,
1134 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1136 4ed9f614 2019-08-04 stsp .Cm got histedit
1137 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1138 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1139 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1140 4ed9f614 2019-08-04 stsp .Cm got unstage
1141 4ed9f614 2019-08-04 stsp before it can be updated with
1142 4ed9f614 2019-08-04 stsp .Cm got update ,
1143 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1145 4ed9f614 2019-08-04 stsp Short alias for
1146 4ed9f614 2019-08-04 stsp .Cm stage .
1147 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1148 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1149 4ed9f614 2019-08-04 stsp back into non-staged status.
1152 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1153 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1155 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1156 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1157 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1158 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1159 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1160 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1161 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1162 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1165 2e1f37b0 2019-08-08 stsp The options for
1166 2e1f37b0 2019-08-08 stsp .Cm got unstage
1167 2e1f37b0 2019-08-08 stsp are as follows:
1168 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1170 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1171 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1173 2e1f37b0 2019-08-08 stsp (unstage change),
1175 2e1f37b0 2019-08-08 stsp (keep change staged), and
1177 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1178 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1179 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1180 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1181 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1184 2e1f37b0 2019-08-08 stsp option, read
1189 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1190 2e1f37b0 2019-08-08 stsp .Ar response-script
1191 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1194 4ed9f614 2019-08-04 stsp Short alias for
1195 4ed9f614 2019-08-04 stsp .Cm unstage .
1196 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 ...
1197 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1198 896e9b6f 2019-08-26 stsp text format.
1199 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1200 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1201 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1203 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1204 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1205 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1206 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1207 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1208 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1210 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1212 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1213 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1215 01073a5d 2019-08-22 stsp The options for
1216 01073a5d 2019-08-22 stsp .Cm got cat
1217 01073a5d 2019-08-22 stsp are as follows:
1218 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1219 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1220 896e9b6f 2019-08-26 stsp Look up paths in the specified
1221 896e9b6f 2019-08-26 stsp .Ar commit .
1222 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1223 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1224 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1225 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1226 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1227 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1228 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1229 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1230 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1231 01073a5d 2019-08-22 stsp working directory.
1232 01073a5d 2019-08-22 stsp If this directory is a
1234 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1236 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1237 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1238 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1241 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1242 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1243 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1244 74416c47 2019-05-09 stsp The author's name and email address for
1245 21a44f98 2019-07-15 stsp .Cm got commit
1247 21a44f98 2019-07-15 stsp .Cm got import ,
1248 74416c47 2019-05-09 stsp for example:
1249 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1252 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1254 84792843 2019-08-09 stsp attempts to reject
1255 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1256 84792843 2019-08-09 stsp environment variables with a missing email address.
1258 c9956ddf 2019-09-08 stsp If present, Git's
1259 aba9c984 2019-09-08 stsp .Dv user.name
1261 709ae9eb 2019-09-08 stsp .Dv user.email
1262 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1263 aba9c984 2019-09-08 stsp .Pa .git/config
1264 aba9c984 2019-09-08 stsp file will override the value of
1265 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1266 c9956ddf 2019-09-08 stsp However, the
1267 c9956ddf 2019-09-08 stsp .Dv user.name
1269 c9956ddf 2019-09-08 stsp .Dv user.email
1270 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1271 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1272 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1273 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1274 c9956ddf 2019-09-08 stsp environment variable is
1277 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1278 23594da9 2019-05-13 stsp The editor spawned by
1279 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1280 8e7bd50a 2019-08-22 stsp .Cm got import ,
1282 8e7bd50a 2019-08-22 stsp .Cm got tag .
1283 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1284 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1285 b1ebc001 2019-08-13 stsp .Cm got log .
1286 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1287 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1289 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1290 5c860e29 2018-03-12 stsp .Ex -std got
1291 97925469 2018-03-17 stsp .Sh EXAMPLES
1292 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1294 fa6e0e48 2019-05-23 stsp This step currently requires
1295 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1297 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1298 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1300 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1302 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1303 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1304 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1306 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1307 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1309 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1311 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1313 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1315 e70c17ce 2019-05-22 stsp .Dl $ got status
1316 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1318 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1320 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1322 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1324 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1326 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1327 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1328 d83d9d5c 2019-05-13 stsp which is forked off the
1329 d83d9d5c 2019-05-13 stsp .Dq master
1332 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1334 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1335 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1336 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1338 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1340 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1341 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1343 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1345 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1346 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1347 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1349 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
1351 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1353 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1354 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1356 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1357 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1359 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1361 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1362 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1363 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1365 95fc3404 2019-07-15 stsp .Dl $ got update
1367 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1368 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1369 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1371 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1372 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1373 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1374 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1376 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
1377 9221fb1e 2019-06-26 stsp This step currently requires
1378 9221fb1e 2019-06-26 stsp .Xr git 1 :
1380 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1381 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
1383 fa6e0e48 2019-05-23 stsp Rebase the
1384 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1385 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1386 fa6e0e48 2019-05-23 stsp .Dq master
1389 818c7501 2019-07-11 stsp .Dl $ got update -b master
1390 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1392 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1393 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1394 1dd86744 2019-08-12 anthony .Ox Ns 's
1395 1dd86744 2019-08-12 anthony CVS tree:
1397 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1399 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1400 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1403 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1404 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1405 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1407 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
1408 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1409 7b3fde24 2019-07-28 stsp .Cm git fetch
1411 7b3fde24 2019-07-28 stsp .Cm git push .
1412 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1413 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
1415 ff2cf171 2019-07-28 stsp .Dq refspec
1416 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1418 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1419 ff2cf171 2019-07-28 stsp namespace of the local repository.
1420 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1421 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1422 ff2cf171 2019-07-28 stsp configuration variable to the value
1423 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1425 ff2cf171 2019-07-28 stsp .Cm git config
1428 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1429 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1431 ff2cf171 2019-07-28 stsp Alternatively, the following
1433 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1434 ff2cf171 2019-07-28 stsp .Pa config
1437 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1438 ff2cf171 2019-07-28 stsp .Dl url = ...
1439 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1441 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1442 ff2cf171 2019-07-28 stsp .Dq refs/heads
1443 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1444 ff2cf171 2019-07-28 stsp .Cm got checkout
1445 ff2cf171 2019-07-28 stsp and, if needed, created with
1446 ff2cf171 2019-07-28 stsp .Cm got branch .
1448 ff2cf171 2019-07-28 stsp Branches in the
1449 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1450 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
1451 ff2cf171 2019-07-28 stsp repository with
1452 ff2cf171 2019-07-28 stsp .Cm git fetch :
1454 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1455 ff2cf171 2019-07-28 stsp .Dl $ git fetch
1457 ff2cf171 2019-07-28 stsp Before outgoing changes on the local
1458 ff2cf171 2019-07-28 stsp .Dq master
1459 ff2cf171 2019-07-28 stsp branch can be pushed to the remote repository, the local
1460 ff2cf171 2019-07-28 stsp .Dq master
1461 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1462 ff2cf171 2019-07-28 stsp .Dq origin/master
1465 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1466 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1468 ff2cf171 2019-07-28 stsp Changes on the local
1469 ff2cf171 2019-07-28 stsp .Dq master
1470 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1471 ff2cf171 2019-07-28 stsp repository with
1472 ff2cf171 2019-07-28 stsp .Cm git push :
1474 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1475 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1476 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1477 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1478 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1479 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1480 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1481 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1482 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1483 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1484 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1486 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1487 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1489 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1490 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
