Blame


1 5c860e29 2018-03-12 stsp .\"
2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5d56da81 2019-01-13 stsp .\" Copyright (c) 2018, 2019 Stefan Sperling
4 5c860e29 2018-03-12 stsp .\"
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.
8 5c860e29 2018-03-12 stsp .\"
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.
16 5c860e29 2018-03-12 stsp .\"
17 5c860e29 2018-03-12 stsp .Dd $Mdocdate$
18 5c860e29 2018-03-12 stsp .Dt GOT 1
19 5c860e29 2018-03-12 stsp .Os
20 5c860e29 2018-03-12 stsp .Sh NAME
21 5c860e29 2018-03-12 stsp .Nm got
22 8e13c46f 2019-08-05 stsp .Nd Game of Trees
23 5c860e29 2018-03-12 stsp .Sh SYNOPSIS
24 0bb8a95e 2018-03-12 stsp .Nm
25 5c860e29 2018-03-12 stsp .Ar command
26 1b6b95a8 2018-03-12 stsp .Op Fl h
27 5c860e29 2018-03-12 stsp .Op Ar arg ...
28 5c860e29 2018-03-12 stsp .Sh DESCRIPTION
29 5c860e29 2018-03-12 stsp .Nm
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 .
34 285dc8a4 2018-03-13 stsp .Pp
35 4129c201 2018-03-13 stsp .Nm
36 4129c201 2018-03-13 stsp is a
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.
41 4129c201 2018-03-13 stsp .Pp
42 285dc8a4 2018-03-13 stsp Files managed by
43 285dc8a4 2018-03-13 stsp .Nm
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 .
50 285dc8a4 2018-03-13 stsp .Pp
51 285dc8a4 2018-03-13 stsp .Nm
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
55 1b6b95a8 2018-03-12 stsp .It Fl h
56 fef8a0d3 2019-08-04 stsp Display usage information and exit immediately.
57 53ccebc2 2019-07-30 stsp .It Fl V
58 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
59 1b6b95a8 2018-03-12 stsp .El
60 1b6b95a8 2018-03-12 stsp .Pp
61 38e11793 2018-06-13 stsp The commands for
62 38e11793 2018-06-13 stsp .Nm
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 .
68 3ce1b845 2019-07-15 stsp .Pp
69 3ce1b845 2019-07-15 stsp After
70 3ce1b845 2019-07-15 stsp .Cm got init ,
71 3ce1b845 2019-07-15 stsp the
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.
76 bc26cce8 2019-08-04 stsp .It Cm in
77 bc26cce8 2019-08-04 stsp Short alias for
78 bc26cce8 2019-08-04 stsp .Cm init .
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.
88 3ce1b845 2019-07-15 stsp .Pp
89 21a44f98 2019-07-15 stsp The
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
96 aba9c984 2019-09-08 stsp and
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.
103 3ce1b845 2019-07-15 stsp .Pp
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
110 3ce1b845 2019-07-15 stsp .Ar branch
111 3ce1b845 2019-07-15 stsp instead of creating the default branch
112 5d67f40d 2019-11-08 stsp .Dq main .
113 3ce1b845 2019-07-15 stsp Use of this option is required if the
114 5d67f40d 2019-11-08 stsp .Dq main
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
119 3ce1b845 2019-07-15 stsp .Fl m
120 3ce1b845 2019-07-15 stsp option,
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.
131 3ce1b845 2019-07-15 stsp The
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 .
135 3ce1b845 2019-07-15 stsp .El
136 bc26cce8 2019-08-04 stsp .It Cm im
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.
141 5d7c1dab 2018-04-01 stsp If the
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 ,
145 5d7c1dab 2018-04-01 stsp or if a
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 .
149 38e11793 2018-06-13 stsp .Pp
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
161 3c575567 2019-07-28 stsp .Ar commit
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.
174 38e11793 2018-06-13 stsp .El
175 97b3a7be 2019-07-09 stsp .It Cm co
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
189 7f838b36 2019-02-08 stsp .El
190 7f838b36 2019-02-08 stsp .Pp
191 f2ea84fa 2019-07-27 stsp If no
192 c4cdcb68 2019-04-03 stsp .Ar path
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.
199 f2cf8fbb 2019-04-04 stsp Some
200 f2cf8fbb 2019-04-04 stsp .Nm
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
207 024e9686 2019-05-14 stsp .Ar path
208 024e9686 2019-05-14 stsp is incompatible with the
209 024e9686 2019-05-14 stsp .Fl b
210 024e9686 2019-05-14 stsp option.
211 7f838b36 2019-02-08 stsp .Pp
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 .
220 4ed9f614 2019-08-04 stsp .Pp
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
227 024e9686 2019-05-14 stsp .Ar branch
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.
239 507dc3bb 2018-12-29 stsp .El
240 97b3a7be 2019-07-09 stsp .It Cm up
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
254 6bad629b 2019-02-04 stsp .Nm
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
257 2a06fe5f 2019-08-24 stsp .Ar path
258 2a06fe5f 2019-08-24 stsp specified on the command line
259 6bad629b 2019-02-04 stsp .El
260 6bad629b 2019-02-04 stsp .Pp
261 72ea6654 2019-07-27 stsp If no
262 927df6b7 2019-02-10 stsp .Ar path
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.
265 4ed9f614 2019-08-04 stsp .Pp
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
274 4ed9f614 2019-08-04 stsp .El
275 4ed9f614 2019-08-04 stsp .Pp
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
280 4ed9f614 2019-08-04 stsp .El
281 6841da00 2019-08-08 stsp .Pp
282 6841da00 2019-08-08 stsp For compatibility with
283 bd8de430 2019-10-04 stsp .Xr cvs 1
284 bd8de430 2019-10-04 stsp and
285 bd8de430 2019-10-04 stsp .Xr git 1 ,
286 6841da00 2019-08-08 stsp .Cm got status
287 bd8de430 2019-10-04 stsp reads
288 bd8de430 2019-10-04 stsp .Xr glob 7
289 bd8de430 2019-10-04 stsp patterns from
290 6841da00 2019-08-08 stsp .Pa .cvsignore
291 bd8de430 2019-10-04 stsp and
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
296 6841da00 2019-08-08 stsp .Xr glob 7
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,
300 bd8de430 2019-10-04 stsp .Dq ** ,
301 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
302 6841da00 2019-08-08 stsp Unlike
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.
306 bd8de430 2019-10-04 stsp Unlike
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
310 bd8de430 2019-10-04 stsp .Dq \&! ,
311 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
312 bd8de430 2019-10-04 stsp .Dq / ,
313 bd8de430 2019-10-04 stsp in a pattern.
314 97b3a7be 2019-07-09 stsp .It Cm st
315 97b3a7be 2019-07-09 stsp Short alias for
316 97b3a7be 2019-07-09 stsp .Cm status .
317 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
318 38e11793 2018-06-13 stsp Display history of a repository.
319 04ca23f4 2018-07-16 stsp If a
320 04ca23f4 2018-07-16 stsp .Ar path
321 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
322 38e11793 2018-06-13 stsp .Pp
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
338 c0cc5c62 2018-10-18 stsp .Fl p .
339 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
340 cc54c501 2019-07-15 stsp .It Fl f
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.
349 b1ebc001 2019-08-13 stsp The
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.
352 6238ee32 2018-06-13 stsp .It Fl p
353 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
354 44392932 2019-08-25 stsp If a
355 44392932 2019-08-25 stsp .Ar path
356 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
357 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
358 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
359 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
360 04ca23f4 2018-07-16 stsp working directory.
361 e9cf2e30 2019-02-05 stsp If this directory is a
362 e9cf2e30 2019-02-05 stsp .Nm
363 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
364 38e11793 2018-06-13 stsp .El
365 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
366 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
367 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
368 927df6b7 2019-02-10 stsp If a
369 927df6b7 2019-02-10 stsp .Ar path
370 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
371 927df6b7 2019-02-10 stsp .Pp
372 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
373 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
374 d24820bf 2019-08-11 stsp corresponding objects.
375 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
376 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
377 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
378 c0cc5c62 2018-10-18 stsp .Pp
379 c0cc5c62 2018-10-18 stsp The options for
380 c0cc5c62 2018-10-18 stsp .Cm got diff
381 c0cc5c62 2018-10-18 stsp are as follows:
382 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
383 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
384 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
385 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
386 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
387 b72f483a 2019-02-05 stsp Use the repository at the specified path.
388 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
389 b72f483a 2019-02-05 stsp working directory.
390 b72f483a 2019-02-05 stsp If this directory is a
391 b72f483a 2019-02-05 stsp .Nm
392 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
393 4ed9f614 2019-08-04 stsp .It Fl s
394 4ed9f614 2019-08-04 stsp Show changes staged with
395 4ed9f614 2019-08-04 stsp .Cm got stage
396 4ed9f614 2019-08-04 stsp instead of showing local changes.
397 4ed9f614 2019-08-04 stsp This option is only valid when
398 4ed9f614 2019-08-04 stsp .Cm got diff
399 4ed9f614 2019-08-04 stsp is invoked in a work tree.
400 63035f9f 2019-10-06 stsp .It Fl w
401 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
402 c0cc5c62 2018-10-18 stsp .El
403 bc26cce8 2019-08-04 stsp .It Cm di
404 bc26cce8 2019-08-04 stsp Short alias for
405 bc26cce8 2019-08-04 stsp .Cm diff .
406 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
407 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
408 1ff8e573 2018-08-02 stsp .Pp
409 1ff8e573 2018-08-02 stsp The options for
410 1ff8e573 2018-08-02 stsp .Cm got blame
411 1ff8e573 2018-08-02 stsp are as follows:
412 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
413 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
414 1ff8e573 2018-08-02 stsp Start traversing history at the specified
415 1ff8e573 2018-08-02 stsp .Ar commit .
416 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
417 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
418 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
419 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
420 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
421 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
422 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
423 1ff8e573 2018-08-02 stsp working directory.
424 0c06baac 2019-02-05 stsp If this directory is a
425 0c06baac 2019-02-05 stsp .Nm
426 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
427 5c860e29 2018-03-12 stsp .El
428 bc26cce8 2019-08-04 stsp .It Cm bl
429 bc26cce8 2019-08-04 stsp Short alias for
430 bc26cce8 2019-08-04 stsp .Cm blame .
431 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
432 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
433 5de5890b 2018-10-18 stsp directory path in the repository.
434 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
435 db0c2996 2019-02-10 stsp annotations:
436 db0c2996 2019-02-10 stsp .Bl -column YXZ description
437 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
438 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
439 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
440 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
441 db0c2996 2019-02-10 stsp .El
442 db0c2996 2019-02-10 stsp .Pp
443 0c849583 2019-02-05 stsp If no
444 0c849583 2019-02-05 stsp .Ar path
445 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
446 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
447 0c849583 2019-02-05 stsp if there is no work tree.
448 5de5890b 2018-10-18 stsp .Pp
449 5de5890b 2018-10-18 stsp The options for
450 5de5890b 2018-10-18 stsp .Cm got tree
451 5de5890b 2018-10-18 stsp are as follows:
452 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
453 5de5890b 2018-10-18 stsp .It Fl c Ar commit
454 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
455 5de5890b 2018-10-18 stsp .Ar commit .
456 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
457 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
458 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
459 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
460 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
461 5de5890b 2018-10-18 stsp Use the repository at the specified path.
462 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
463 5de5890b 2018-10-18 stsp working directory.
464 0c849583 2019-02-05 stsp If this directory is a
465 0c849583 2019-02-05 stsp .Nm
466 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
467 5de5890b 2018-10-18 stsp .It Fl i
468 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
469 c1669e2e 2019-01-09 stsp .It Fl R
470 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
471 d0eebce4 2019-03-11 stsp .El
472 bc26cce8 2019-08-04 stsp .It Cm tr
473 bc26cce8 2019-08-04 stsp Short alias for
474 bc26cce8 2019-08-04 stsp .Cm tree .
475 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
476 d0eebce4 2019-03-11 stsp Manage references in a repository.
477 d0eebce4 2019-03-11 stsp .Pp
478 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
479 d0eebce4 2019-03-11 stsp or update, the reference with the given
480 d0eebce4 2019-03-11 stsp .Ar name ,
481 d0eebce4 2019-03-11 stsp and make it point at the given
482 d83d9d5c 2019-05-13 stsp .Ar target .
483 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
484 f16e4044 2019-10-09 stsp .Dq refs/ .
485 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
486 a54b6686 2019-06-28 stsp will be resolved to an object ID.
487 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
488 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
489 d0eebce4 2019-03-11 stsp .Pp
490 d0eebce4 2019-03-11 stsp The options for
491 d0eebce4 2019-03-11 stsp .Cm got ref
492 d0eebce4 2019-03-11 stsp are as follows:
493 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
494 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
495 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
496 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
497 d0eebce4 2019-03-11 stsp working directory.
498 d0eebce4 2019-03-11 stsp If this directory is a
499 d0eebce4 2019-03-11 stsp .Nm
500 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
501 d0eebce4 2019-03-11 stsp .It Fl l
502 d0eebce4 2019-03-11 stsp List all existing references in the repository.
503 d0eebce4 2019-03-11 stsp .It Fl d Ar name
504 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
505 d1c1ae5f 2019-08-12 stsp .It Fl s
506 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
507 d1c1ae5f 2019-08-12 stsp .Ar target ,
508 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
509 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
510 d1c1ae5f 2019-08-12 stsp this option is used.
511 4e759de4 2019-06-26 stsp .El
512 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
513 4e759de4 2019-06-26 stsp Manage branches in a repository.
514 4e759de4 2019-06-26 stsp .Pp
515 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
516 4e759de4 2019-06-26 stsp .Dq refs/heads/
517 4e759de4 2019-06-26 stsp reference namespace.
518 4e759de4 2019-06-26 stsp The
519 4e759de4 2019-06-26 stsp .Cm got branch
520 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
521 4e759de4 2019-06-26 stsp .Pp
522 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
523 ad89fa31 2019-10-04 stsp work tree's current branch.
524 a74f7e83 2019-11-10 stsp If a
525 a74f7e83 2019-11-10 stsp .Ar name
526 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
527 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
528 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
529 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
530 4e759de4 2019-06-26 stsp .Pp
531 4e759de4 2019-06-26 stsp The options for
532 4e759de4 2019-06-26 stsp .Cm got branch
533 4e759de4 2019-06-26 stsp are as follows:
534 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
535 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
536 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
537 a74f7e83 2019-11-10 stsp .Ar commit .
538 a74f7e83 2019-11-10 stsp The expected
539 a74f7e83 2019-11-10 stsp .Ar commit
540 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
541 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
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
547 4e759de4 2019-06-26 stsp .Nm
548 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
549 4e759de4 2019-06-26 stsp .It Fl l
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
556 ba882ee3 2019-07-11 stsp .El
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.
563 5de5890b 2018-10-18 stsp .El
564 97b3a7be 2019-07-09 stsp .It Cm br
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.
569 8e7bd50a 2019-08-22 stsp .Pp
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.
573 8e7bd50a 2019-08-22 stsp The
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.
578 8e7bd50a 2019-08-22 stsp .Pp
579 8e7bd50a 2019-08-22 stsp Expect one or two arguments and attempt to create a tag with the given
580 8e7bd50a 2019-08-22 stsp .Ar name ,
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.
590 8e7bd50a 2019-08-22 stsp .Pp
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
598 8e7bd50a 2019-08-22 stsp .Fl m
599 8e7bd50a 2019-08-22 stsp option,
600 3a62228f 2019-11-08 stsp .Cm got tag
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
607 8e7bd50a 2019-08-22 stsp .Nm
608 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
609 8e7bd50a 2019-08-22 stsp .It Fl l
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.
612 8e7bd50a 2019-08-22 stsp .El
613 8e7bd50a 2019-08-22 stsp .Pp
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 4e68cba3 2019-11-23 stsp .It Cm add Oo Fl R Oc Ar 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 4e68cba3 2019-11-23 stsp .Pp
626 4e68cba3 2019-11-23 stsp The options for
627 4e68cba3 2019-11-23 stsp .Cm got add
628 4e68cba3 2019-11-23 stsp are as follows:
629 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
630 4e68cba3 2019-11-23 stsp .It Fl R
631 4e68cba3 2019-11-23 stsp Permit recursion into directories.
632 4e68cba3 2019-11-23 stsp If this option is not specified,
633 4e68cba3 2019-11-23 stsp .Cm got add
634 4e68cba3 2019-11-23 stsp will refuse to run if a specified
635 4e68cba3 2019-11-23 stsp .Ar path
636 4e68cba3 2019-11-23 stsp is a directory.
637 4e68cba3 2019-11-23 stsp .El
638 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
639 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
640 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
641 2ec1f75b 2019-03-26 stsp .Pp
642 2ec1f75b 2019-03-26 stsp The options for
643 86d25a1b 2019-07-11 stsp .Cm got remove
644 2ec1f75b 2019-03-26 stsp are as follows:
645 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
646 2ec1f75b 2019-03-26 stsp .It Fl f
647 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
648 d0eebce4 2019-03-11 stsp .El
649 648e4ef7 2019-07-09 stsp .It Cm rm
650 648e4ef7 2019-07-09 stsp Short alias for
651 648e4ef7 2019-07-09 stsp .Cm remove .
652 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 ...
653 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
654 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
655 1dd86744 2019-08-12 anthony work tree's base commit.
656 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
657 a129376b 2019-03-28 stsp .Cm got revert !
658 a129376b 2019-03-28 stsp .Pp
659 e20a8b6f 2019-06-04 stsp If a file was added with
660 a129376b 2019-03-28 stsp .Cm got add
661 a129376b 2019-03-28 stsp it will become an unversioned file again.
662 e20a8b6f 2019-06-04 stsp If a file was deleted with
663 86d25a1b 2019-07-11 stsp .Cm got remove
664 a129376b 2019-03-28 stsp it will be restored.
665 0f6d7415 2019-08-08 stsp .Pp
666 0f6d7415 2019-08-08 stsp The options for
667 0f6d7415 2019-08-08 stsp .Cm got revert
668 0f6d7415 2019-08-08 stsp are as follows:
669 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
670 33aa809d 2019-08-08 stsp .It Fl p
671 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
672 33aa809d 2019-08-08 stsp changes to revert based on
673 33aa809d 2019-08-08 stsp .Dq y
674 33aa809d 2019-08-08 stsp (revert change),
675 33aa809d 2019-08-08 stsp .Dq n
676 33aa809d 2019-08-08 stsp (keep change), and
677 33aa809d 2019-08-08 stsp .Dq q
678 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
679 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
680 33aa809d 2019-08-08 stsp modified file content can be reverted.
681 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
682 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
683 33aa809d 2019-08-08 stsp With the
684 33aa809d 2019-08-08 stsp .Fl p
685 33aa809d 2019-08-08 stsp option, read
686 33aa809d 2019-08-08 stsp .Dq y ,
687 33aa809d 2019-08-08 stsp .Dq n ,
688 33aa809d 2019-08-08 stsp and
689 33aa809d 2019-08-08 stsp .Dq q
690 33aa809d 2019-08-08 stsp responses line-by-line from the specified
691 33aa809d 2019-08-08 stsp .Ar response-script
692 33aa809d 2019-08-08 stsp file instead of prompting interactively.
693 0f6d7415 2019-08-08 stsp .It Fl R
694 0f6d7415 2019-08-08 stsp Permit recursion into directories.
695 0f6d7415 2019-08-08 stsp If this option is not specified,
696 0f6d7415 2019-08-08 stsp .Cm got revert
697 0f6d7415 2019-08-08 stsp will refuse to run if a specified
698 0f6d7415 2019-08-08 stsp .Ar path
699 0f6d7415 2019-08-08 stsp is a directory.
700 0f6d7415 2019-08-08 stsp .El
701 97b3a7be 2019-07-09 stsp .It Cm rv
702 97b3a7be 2019-07-09 stsp Short alias for
703 97b3a7be 2019-07-09 stsp .Cm revert .
704 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
705 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
706 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
707 5c1e53bc 2019-07-28 stsp If no
708 90e8619e 2019-07-25 stsp .Ar path
709 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
710 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
711 15cd91f7 2019-05-12 stsp .Pp
712 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
713 1dd86744 2019-08-12 anthony .Cm got stage ,
714 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
715 4ed9f614 2019-08-04 stsp have not been staged.
716 4ed9f614 2019-08-04 stsp .Pp
717 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
718 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
719 15cd91f7 2019-05-12 stsp .It M Ta modified file
720 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
721 15cd91f7 2019-05-12 stsp .It A Ta new file was added
722 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
723 15cd91f7 2019-05-12 stsp .El
724 15cd91f7 2019-05-12 stsp .Pp
725 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
726 996d5ccd 2019-08-05 stsp recorded base commit.
727 15cd91f7 2019-05-12 stsp Some
728 15cd91f7 2019-05-12 stsp .Nm
729 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
730 15cd91f7 2019-05-12 stsp multiple base commits.
731 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
732 47ec7be7 2019-05-12 stsp .Cm got update
733 47ec7be7 2019-05-12 stsp across the entire work tree.
734 15cd91f7 2019-05-12 stsp .Pp
735 15cd91f7 2019-05-12 stsp The
736 15cd91f7 2019-05-12 stsp .Cm got commit
737 15cd91f7 2019-05-12 stsp command requires the
738 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
739 aba9c984 2019-09-08 stsp environment variable to be set,
740 aba9c984 2019-09-08 stsp unless Git's
741 aba9c984 2019-09-08 stsp .Dv user.name
742 aba9c984 2019-09-08 stsp and
743 709ae9eb 2019-09-08 stsp .Dv user.email
744 709ae9eb 2019-09-08 stsp configuration settings can be
745 aba9c984 2019-09-08 stsp obtained from the repository's
746 aba9c984 2019-09-08 stsp .Pa .git/config
747 c9956ddf 2019-09-08 stsp file or from Git's global
748 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
749 c9956ddf 2019-09-08 stsp configuration file.
750 74416c47 2019-05-09 stsp .Pp
751 74416c47 2019-05-09 stsp The options for
752 74416c47 2019-05-09 stsp .Cm got commit
753 74416c47 2019-05-09 stsp are as follows:
754 74416c47 2019-05-09 stsp .Bl -tag -width Ds
755 74ff3f23 2019-07-07 stsp .It Fl m Ar message
756 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
757 23594da9 2019-05-13 stsp Without the
758 23594da9 2019-05-13 stsp .Fl m
759 23594da9 2019-05-13 stsp option,
760 23594da9 2019-05-13 stsp .Cm got commit
761 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
762 2ec1f75b 2019-03-26 stsp .El
763 cfce0458 2019-07-28 stsp .Pp
764 cfce0458 2019-07-28 stsp .Cm got commit
765 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
766 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
767 916f288c 2019-07-30 stsp .Dq refs/heads/
768 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
769 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
770 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
771 cfce0458 2019-07-28 stsp If a path is found to be out of date,
772 cfce0458 2019-07-28 stsp .Cm got update
773 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
774 cfce0458 2019-07-28 stsp in the repository.
775 97b3a7be 2019-07-09 stsp .It Cm ci
776 97b3a7be 2019-07-09 stsp Short alias for
777 97b3a7be 2019-07-09 stsp .Cm commit .
778 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
779 234035bc 2019-06-01 stsp Merge changes from a single
780 234035bc 2019-06-01 stsp .Ar commit
781 234035bc 2019-06-01 stsp into the work tree.
782 234035bc 2019-06-01 stsp The specified
783 234035bc 2019-06-01 stsp .Ar commit
784 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
785 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
786 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
787 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
788 234035bc 2019-06-01 stsp .Pp
789 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
790 234035bc 2019-06-01 stsp .Bl -column YXZ description
791 234035bc 2019-06-01 stsp .It G Ta file was merged
792 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
793 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
794 234035bc 2019-06-01 stsp .It D Ta file was deleted
795 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
796 234035bc 2019-06-01 stsp .It A Ta new file was added
797 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
798 74416c47 2019-05-09 stsp .El
799 234035bc 2019-06-01 stsp .Pp
800 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
801 234035bc 2019-06-01 stsp may be viewed with
802 234035bc 2019-06-01 stsp .Cm got diff ,
803 234035bc 2019-06-01 stsp amended manually or with further
804 234035bc 2019-06-01 stsp .Cm got cherrypick
805 bc3056e3 2019-08-18 stsp commands,
806 234035bc 2019-06-01 stsp committed with
807 234035bc 2019-06-01 stsp .Cm got commit ,
808 234035bc 2019-06-01 stsp or discarded again with
809 234035bc 2019-06-01 stsp .Cm got revert .
810 234035bc 2019-06-01 stsp .Pp
811 234035bc 2019-06-01 stsp .Cm got cherrypick
812 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
813 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
814 234035bc 2019-06-01 stsp to a single base commit with
815 234035bc 2019-06-01 stsp .Cm got update .
816 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
817 234035bc 2019-06-01 stsp conflicts must be resolved first.
818 016477fd 2019-07-09 stsp .It Cm cy
819 97b3a7be 2019-07-09 stsp Short alias for
820 97b3a7be 2019-07-09 stsp .Cm cherrypick .
821 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
822 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
823 5ef14e63 2019-06-02 stsp .Ar commit
824 5ef14e63 2019-06-02 stsp into the work tree.
825 5ef14e63 2019-06-02 stsp The specified
826 5ef14e63 2019-06-02 stsp .Ar commit
827 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
828 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
829 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
830 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
831 5ef14e63 2019-06-02 stsp .Pp
832 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
833 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
834 5ef14e63 2019-06-02 stsp .It G Ta file was merged
835 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
836 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
837 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
838 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
839 5ef14e63 2019-06-02 stsp .It A Ta new file was added
840 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
841 234035bc 2019-06-01 stsp .El
842 5ef14e63 2019-06-02 stsp .Pp
843 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
844 5ef14e63 2019-06-02 stsp which may be viewed with
845 5ef14e63 2019-06-02 stsp .Cm got diff ,
846 5ef14e63 2019-06-02 stsp amended manually or with further
847 778a73c2 2019-07-12 stsp .Cm got backout
848 bc3056e3 2019-08-18 stsp commands,
849 5ef14e63 2019-06-02 stsp committed with
850 5ef14e63 2019-06-02 stsp .Cm got commit ,
851 5ef14e63 2019-06-02 stsp or discarded again with
852 5ef14e63 2019-06-02 stsp .Cm got revert .
853 5ef14e63 2019-06-02 stsp .Pp
854 92228c38 2019-06-02 stsp .Cm got backout
855 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
856 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
857 92228c38 2019-06-02 stsp to a single base commit with
858 92228c38 2019-06-02 stsp .Cm got update .
859 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
860 92228c38 2019-06-02 stsp conflicts must be resolved first.
861 97b3a7be 2019-07-09 stsp .It Cm bo
862 97b3a7be 2019-07-09 stsp Short alias for
863 97b3a7be 2019-07-09 stsp .Cm backout .
864 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
865 818c7501 2019-07-11 stsp Rebase commits on the specified
866 818c7501 2019-07-11 stsp .Ar branch
867 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
868 818c7501 2019-07-11 stsp The
869 818c7501 2019-07-11 stsp .Ar branch
870 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
871 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
872 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
873 818c7501 2019-07-11 stsp .Ar branch
874 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
875 f09e2405 2019-07-11 stsp of the specified
876 818c7501 2019-07-11 stsp .Ar branch
877 f09e2405 2019-07-11 stsp has been rebased.
878 818c7501 2019-07-11 stsp .Pp
879 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
880 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
881 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
882 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
883 818c7501 2019-07-11 stsp .Ar branch ,
884 818c7501 2019-07-11 stsp but with different commit IDs.
885 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
886 f09e2405 2019-07-11 stsp the new version of the specified
887 818c7501 2019-07-11 stsp .Ar branch
888 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
889 818c7501 2019-07-11 stsp .Pp
890 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
891 818c7501 2019-07-11 stsp using the following status codes:
892 818c7501 2019-07-11 stsp .Bl -column YXZ description
893 818c7501 2019-07-11 stsp .It G Ta file was merged
894 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
895 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
896 818c7501 2019-07-11 stsp .It D Ta file was deleted
897 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
898 818c7501 2019-07-11 stsp .It A Ta new file was added
899 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
900 5ef14e63 2019-06-02 stsp .El
901 818c7501 2019-07-11 stsp .Pp
902 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
903 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
904 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
905 818c7501 2019-07-11 stsp .Ar branch
906 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
907 818c7501 2019-07-11 stsp .Pp
908 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
909 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
910 f09e2405 2019-07-11 stsp when the rebase operation continues.
911 ff0d2220 2019-07-11 stsp .Pp
912 818c7501 2019-07-11 stsp .Cm got rebase
913 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
914 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
915 818c7501 2019-07-11 stsp to a single base commit with
916 818c7501 2019-07-11 stsp .Cm got update .
917 4ed9f614 2019-08-04 stsp If changes have been staged with
918 4ed9f614 2019-08-04 stsp .Cm got stage ,
919 bc3056e3 2019-08-18 stsp these changes must first be committed with
920 4ed9f614 2019-08-04 stsp .Cm got commit
921 4ed9f614 2019-08-04 stsp or unstaged with
922 4ed9f614 2019-08-04 stsp .Cm got unstage .
923 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
924 f09e2405 2019-07-11 stsp committed with
925 f09e2405 2019-07-11 stsp .Cm got commit
926 f09e2405 2019-07-11 stsp or reverted with
927 f09e2405 2019-07-11 stsp .Cm got revert .
928 64c6d990 2019-07-11 stsp If the
929 64c6d990 2019-07-11 stsp .Ar branch
930 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
931 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
932 818c7501 2019-07-11 stsp .Pp
933 7d5807f4 2019-07-11 stsp The
934 7d5807f4 2019-07-11 stsp .Cm got update
935 7d5807f4 2019-07-11 stsp and
936 7d5807f4 2019-07-11 stsp .Cm got commit
937 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
938 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
939 7d5807f4 2019-07-11 stsp conflict resolution purposes.
940 818c7501 2019-07-11 stsp .Pp
941 818c7501 2019-07-11 stsp The options for
942 818c7501 2019-07-11 stsp .Cm got rebase
943 818c7501 2019-07-11 stsp are as follows:
944 818c7501 2019-07-11 stsp .Bl -tag -width Ds
945 818c7501 2019-07-11 stsp .It Fl a
946 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
947 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
948 818c7501 2019-07-11 stsp .It Fl c
949 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
950 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
951 818c7501 2019-07-11 stsp .El
952 818c7501 2019-07-11 stsp .It Cm rb
953 818c7501 2019-07-11 stsp Short alias for
954 818c7501 2019-07-11 stsp .Cm rebase .
955 dfc23429 2019-08-11 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
956 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
957 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
958 0ebf8283 2019-07-24 stsp .Pp
959 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
960 0ebf8283 2019-07-24 stsp .Ar histedit script
961 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
962 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
963 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
964 0ebf8283 2019-07-24 stsp whitespace and an argument.
965 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
966 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
967 0ebf8283 2019-07-24 stsp Lines which begin with the
968 0ebf8283 2019-07-24 stsp .Sq #
969 0ebf8283 2019-07-24 stsp character are ignored entirely.
970 0ebf8283 2019-07-24 stsp .Pp
971 0ebf8283 2019-07-24 stsp The available commands are as follows:
972 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
973 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
974 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
975 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
976 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
977 0ebf8283 2019-07-24 stsp listed further below that will be used.
978 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
979 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
980 0ebf8283 2019-07-24 stsp the commit on the previous line.
981 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
982 0ebf8283 2019-07-24 stsp log message can be written.
983 0ebf8283 2019-07-24 stsp .El
984 0ebf8283 2019-07-24 stsp .Pp
985 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
986 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
987 0ebf8283 2019-07-24 stsp .Pp
988 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
989 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
990 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
991 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
992 498a90b7 2019-07-25 stsp switched to it.
993 0ebf8283 2019-07-24 stsp .Pp
994 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
995 0ebf8283 2019-07-24 stsp using the following status codes:
996 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
997 0ebf8283 2019-07-24 stsp .It G Ta file was merged
998 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
999 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1000 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1001 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1002 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1003 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1004 0ebf8283 2019-07-24 stsp .El
1005 0ebf8283 2019-07-24 stsp .Pp
1006 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1007 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1008 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1009 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1010 0ebf8283 2019-07-24 stsp .Pp
1011 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1012 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1013 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1014 0ebf8283 2019-07-24 stsp .Pp
1015 0ebf8283 2019-07-24 stsp .Cm got histedit
1016 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1017 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1018 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1019 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1020 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1021 0ebf8283 2019-07-24 stsp to a single base commit with
1022 0ebf8283 2019-07-24 stsp .Cm got update .
1023 4ed9f614 2019-08-04 stsp If changes have been staged with
1024 4ed9f614 2019-08-04 stsp .Cm got stage ,
1025 bc3056e3 2019-08-18 stsp these changes must first be committed with
1026 4ed9f614 2019-08-04 stsp .Cm got commit
1027 4ed9f614 2019-08-04 stsp or unstaged with
1028 4ed9f614 2019-08-04 stsp .Cm got unstage .
1029 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1030 0ebf8283 2019-07-24 stsp committed with
1031 0ebf8283 2019-07-24 stsp .Cm got commit
1032 0ebf8283 2019-07-24 stsp or reverted with
1033 0ebf8283 2019-07-24 stsp .Cm got revert .
1034 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1035 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1036 0ebf8283 2019-07-24 stsp .Pp
1037 0ebf8283 2019-07-24 stsp The
1038 0ebf8283 2019-07-24 stsp .Cm got update
1039 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
1040 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1041 0ebf8283 2019-07-24 stsp .Cm got commit
1042 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1043 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1044 0ebf8283 2019-07-24 stsp .Pp
1045 0ebf8283 2019-07-24 stsp The options for
1046 0ebf8283 2019-07-24 stsp .Cm got histedit
1047 0ebf8283 2019-07-24 stsp are as follows:
1048 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1049 0ebf8283 2019-07-24 stsp .It Fl a
1050 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1051 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1052 0ebf8283 2019-07-24 stsp .It Fl c
1053 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1054 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1055 818c7501 2019-07-11 stsp .El
1056 0ebf8283 2019-07-24 stsp .It Cm he
1057 0ebf8283 2019-07-24 stsp Short alias for
1058 0ebf8283 2019-07-24 stsp .Cm histedit .
1059 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1060 2822a352 2019-10-15 stsp Integrate the specified
1061 2822a352 2019-10-15 stsp .Ar branch
1062 2822a352 2019-10-15 stsp into the work tree's current branch.
1063 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1064 2822a352 2019-10-15 stsp .Ar branch ,
1065 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1066 2822a352 2019-10-15 stsp head commit of the integrated
1067 2822a352 2019-10-15 stsp .Ar branch .
1068 2822a352 2019-10-15 stsp .Pp
1069 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1070 2822a352 2019-10-15 stsp will be pointing at the same commit.
1071 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1072 2822a352 2019-10-15 stsp In case the integrated
1073 2822a352 2019-10-15 stsp .Ar branch
1074 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1075 2822a352 2019-10-15 stsp .Cm got branch -d .
1076 2822a352 2019-10-15 stsp .Pp
1077 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1078 2822a352 2019-10-15 stsp .Bl -column YXZ description
1079 2822a352 2019-10-15 stsp .It U Ta file was updated
1080 2822a352 2019-10-15 stsp .It D Ta file was deleted
1081 2822a352 2019-10-15 stsp .It A Ta new file was added
1082 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1083 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1084 2822a352 2019-10-15 stsp .El
1085 2822a352 2019-10-15 stsp .Pp
1086 2822a352 2019-10-15 stsp .Cm got integrate
1087 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1088 2822a352 2019-10-15 stsp Most importantly, the
1089 2822a352 2019-10-15 stsp .Ar branch
1090 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1091 2822a352 2019-10-15 stsp .Cm got rebase
1092 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1093 2822a352 2019-10-15 stsp resolve merge conflicts.
1094 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1095 2822a352 2019-10-15 stsp to a single base commit with
1096 2822a352 2019-10-15 stsp .Cm got update .
1097 2822a352 2019-10-15 stsp If changes have been staged with
1098 2822a352 2019-10-15 stsp .Cm got stage ,
1099 2822a352 2019-10-15 stsp these changes must first be committed with
1100 2822a352 2019-10-15 stsp .Cm got commit
1101 2822a352 2019-10-15 stsp or unstaged with
1102 2822a352 2019-10-15 stsp .Cm got unstage .
1103 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1104 2822a352 2019-10-15 stsp committed with
1105 2822a352 2019-10-15 stsp .Cm got commit
1106 2822a352 2019-10-15 stsp or reverted with
1107 2822a352 2019-10-15 stsp .Cm got revert .
1108 2822a352 2019-10-15 stsp .It Cm ig
1109 2822a352 2019-10-15 stsp Short alias for
1110 2822a352 2019-10-15 stsp .Cm integrate .
1111 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 ...
1112 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1113 2db2652d 2019-08-07 stsp If no
1114 2db2652d 2019-08-07 stsp .Ar path
1115 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1116 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1117 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1118 4ed9f614 2019-08-04 stsp .Cm got status .
1119 4ed9f614 2019-08-04 stsp .Pp
1120 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1121 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1122 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1123 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1124 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1125 9d8b19a4 2019-08-04 stsp .El
1126 9d8b19a4 2019-08-04 stsp .Pp
1127 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1128 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1129 9d8b19a4 2019-08-04 stsp committed.
1130 9d8b19a4 2019-08-04 stsp .Pp
1131 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1132 4ed9f614 2019-08-04 stsp .Cm got commit ,
1133 4ed9f614 2019-08-04 stsp .Cm got status ,
1134 4ed9f614 2019-08-04 stsp and
1135 4ed9f614 2019-08-04 stsp .Cm got diff .
1136 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1137 4ed9f614 2019-08-04 stsp .Cm got commit
1138 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1139 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1140 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1141 4ed9f614 2019-08-04 stsp The
1142 4ed9f614 2019-08-04 stsp .Cm got status
1143 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1144 4ed9f614 2019-08-04 stsp The
1145 4ed9f614 2019-08-04 stsp .Cm got diff
1146 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1147 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1148 4ed9f614 2019-08-04 stsp The
1149 4ed9f614 2019-08-04 stsp .Cm got revert
1150 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1151 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1152 4ed9f614 2019-08-04 stsp .Pp
1153 4ed9f614 2019-08-04 stsp The options for
1154 4ed9f614 2019-08-04 stsp .Cm got stage
1155 4ed9f614 2019-08-04 stsp are as follows:
1156 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1157 4ed9f614 2019-08-04 stsp .It Fl l
1158 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1159 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1160 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1161 1dd86744 2019-08-12 anthony among the specified paths.
1162 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1163 dc424a06 2019-08-07 stsp .It Fl p
1164 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1165 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1166 dc424a06 2019-08-07 stsp .Dq y
1167 6d23ec10 2019-08-08 stsp (stage change),
1168 dc424a06 2019-08-07 stsp .Dq n
1169 6d23ec10 2019-08-08 stsp (reject change), and
1170 b353a198 2019-08-07 stsp .Dq q
1171 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1172 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1173 dc424a06 2019-08-07 stsp modified file content can be staged.
1174 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1175 6d23ec10 2019-08-08 stsp their entirety.
1176 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1177 dc424a06 2019-08-07 stsp With the
1178 dc424a06 2019-08-07 stsp .Fl p
1179 3a070a2b 2019-08-07 stsp option, read
1180 3a070a2b 2019-08-07 stsp .Dq y ,
1181 3a070a2b 2019-08-07 stsp .Dq n ,
1182 3a070a2b 2019-08-07 stsp and
1183 3a070a2b 2019-08-07 stsp .Dq q
1184 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1185 0e2f5884 2019-08-07 stsp .Ar response-script
1186 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1187 4ed9f614 2019-08-04 stsp .El
1188 4ed9f614 2019-08-04 stsp .Pp
1189 4ed9f614 2019-08-04 stsp .Cm got stage
1190 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1191 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1192 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1193 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1194 4ed9f614 2019-08-04 stsp .Cm got update
1195 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1196 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1197 4ed9f614 2019-08-04 stsp .Pp
1198 4ed9f614 2019-08-04 stsp The
1199 4ed9f614 2019-08-04 stsp .Cm got update ,
1200 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1201 4ed9f614 2019-08-04 stsp and
1202 4ed9f614 2019-08-04 stsp .Cm got histedit
1203 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1204 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1205 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1206 4ed9f614 2019-08-04 stsp .Cm got unstage
1207 4ed9f614 2019-08-04 stsp before it can be updated with
1208 4ed9f614 2019-08-04 stsp .Cm got update ,
1209 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1210 4ed9f614 2019-08-04 stsp .It Cm sg
1211 4ed9f614 2019-08-04 stsp Short alias for
1212 4ed9f614 2019-08-04 stsp .Cm stage .
1213 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1214 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1215 4ed9f614 2019-08-04 stsp back into non-staged status.
1216 4ed9f614 2019-08-04 stsp If no
1217 4ed9f614 2019-08-04 stsp .Ar path
1218 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1219 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1220 4ed9f614 2019-08-04 stsp .Pp
1221 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1222 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1223 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1224 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1225 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1226 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1227 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1228 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1229 4ed9f614 2019-08-04 stsp .El
1230 2e1f37b0 2019-08-08 stsp .Pp
1231 2e1f37b0 2019-08-08 stsp The options for
1232 2e1f37b0 2019-08-08 stsp .Cm got unstage
1233 2e1f37b0 2019-08-08 stsp are as follows:
1234 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1235 2e1f37b0 2019-08-08 stsp .It Fl p
1236 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1237 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1238 2e1f37b0 2019-08-08 stsp .Dq y
1239 2e1f37b0 2019-08-08 stsp (unstage change),
1240 2e1f37b0 2019-08-08 stsp .Dq n
1241 2e1f37b0 2019-08-08 stsp (keep change staged), and
1242 2e1f37b0 2019-08-08 stsp .Dq q
1243 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1244 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1245 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1246 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1247 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1248 2e1f37b0 2019-08-08 stsp With the
1249 2e1f37b0 2019-08-08 stsp .Fl p
1250 2e1f37b0 2019-08-08 stsp option, read
1251 2e1f37b0 2019-08-08 stsp .Dq y ,
1252 2e1f37b0 2019-08-08 stsp .Dq n ,
1253 2e1f37b0 2019-08-08 stsp and
1254 2e1f37b0 2019-08-08 stsp .Dq q
1255 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1256 2e1f37b0 2019-08-08 stsp .Ar response-script
1257 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1258 2e1f37b0 2019-08-08 stsp .El
1259 4ed9f614 2019-08-04 stsp .It Cm ug
1260 4ed9f614 2019-08-04 stsp Short alias for
1261 4ed9f614 2019-08-04 stsp .Cm unstage .
1262 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 ...
1263 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1264 896e9b6f 2019-08-26 stsp text format.
1265 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1266 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1267 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1268 896e9b6f 2019-08-26 stsp .Pp
1269 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1270 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1271 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1272 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1273 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1274 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1275 01073a5d 2019-08-22 stsp .Pp
1276 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1277 896e9b6f 2019-08-26 stsp .Fl P
1278 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1279 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1280 896e9b6f 2019-08-26 stsp .Pp
1281 01073a5d 2019-08-22 stsp The options for
1282 01073a5d 2019-08-22 stsp .Cm got cat
1283 01073a5d 2019-08-22 stsp are as follows:
1284 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1285 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1286 896e9b6f 2019-08-26 stsp Look up paths in the specified
1287 896e9b6f 2019-08-26 stsp .Ar commit .
1288 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1289 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1290 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1291 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1292 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1293 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1294 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1295 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1296 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1297 01073a5d 2019-08-22 stsp working directory.
1298 01073a5d 2019-08-22 stsp If this directory is a
1299 01073a5d 2019-08-22 stsp .Nm
1300 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1301 896e9b6f 2019-08-26 stsp .It Fl P
1302 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1303 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1304 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1305 4ed9f614 2019-08-04 stsp .El
1306 01073a5d 2019-08-22 stsp .El
1307 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1308 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1309 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1310 74416c47 2019-05-09 stsp The author's name and email address for
1311 21a44f98 2019-07-15 stsp .Cm got commit
1312 21a44f98 2019-07-15 stsp and
1313 21a44f98 2019-07-15 stsp .Cm got import ,
1314 74416c47 2019-05-09 stsp for example:
1315 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1316 84792843 2019-08-09 stsp Because
1317 0e444aba 2019-08-08 stsp .Xr git 1
1318 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1319 0e444aba 2019-08-08 stsp .Nm
1320 84792843 2019-08-09 stsp attempts to reject
1321 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1322 84792843 2019-08-09 stsp environment variables with a missing email address.
1323 c9956ddf 2019-09-08 stsp .Pp
1324 c9956ddf 2019-09-08 stsp If present, Git's
1325 aba9c984 2019-09-08 stsp .Dv user.name
1326 aba9c984 2019-09-08 stsp and
1327 709ae9eb 2019-09-08 stsp .Dv user.email
1328 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1329 aba9c984 2019-09-08 stsp .Pa .git/config
1330 aba9c984 2019-09-08 stsp file will override the value of
1331 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1332 c9956ddf 2019-09-08 stsp However, the
1333 c9956ddf 2019-09-08 stsp .Dv user.name
1334 c9956ddf 2019-09-08 stsp and
1335 c9956ddf 2019-09-08 stsp .Dv user.email
1336 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1337 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1338 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1339 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1340 c9956ddf 2019-09-08 stsp environment variable is
1341 c9956ddf 2019-09-08 stsp .Em not
1342 c9956ddf 2019-09-08 stsp set.
1343 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1344 23594da9 2019-05-13 stsp The editor spawned by
1345 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1346 8e7bd50a 2019-08-22 stsp .Cm got import ,
1347 8e7bd50a 2019-08-22 stsp or
1348 8e7bd50a 2019-08-22 stsp .Cm got tag .
1349 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1350 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1351 b1ebc001 2019-08-13 stsp .Cm got log .
1352 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1353 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1354 74416c47 2019-05-09 stsp .El
1355 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1356 5c860e29 2018-03-12 stsp .Ex -std got
1357 97925469 2018-03-17 stsp .Sh EXAMPLES
1358 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1359 fa6e0e48 2019-05-23 stsp .Nm .
1360 fa6e0e48 2019-05-23 stsp This step currently requires
1361 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1362 d83d9d5c 2019-05-13 stsp .Pp
1363 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1364 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1365 fa6e0e48 2019-05-23 stsp .Pp
1366 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1367 3ce1b845 2019-07-15 stsp .Nm
1368 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1369 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1370 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1371 fa6e0e48 2019-05-23 stsp .Pp
1372 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1373 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1374 3ce1b845 2019-07-15 stsp .Pp
1375 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1376 3ce1b845 2019-07-15 stsp .Pp
1377 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1378 fa6e0e48 2019-05-23 stsp .Pp
1379 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1380 e70c17ce 2019-05-22 stsp .Pp
1381 e70c17ce 2019-05-22 stsp .Dl $ got status
1382 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1383 33aa809d 2019-08-08 stsp .Pp
1384 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1385 e70c17ce 2019-05-22 stsp .Pp
1386 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1387 33aa809d 2019-08-08 stsp .Pp
1388 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1389 e70c17ce 2019-05-22 stsp .Pp
1390 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1391 e70c17ce 2019-05-22 stsp .Pp
1392 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1393 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1394 d83d9d5c 2019-05-13 stsp which is forked off the
1395 d83d9d5c 2019-05-13 stsp .Dq master
1396 d83d9d5c 2019-05-13 stsp branch:
1397 d83d9d5c 2019-05-13 stsp .Pp
1398 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1399 e70c17ce 2019-05-22 stsp .Pp
1400 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1401 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1402 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1403 e70c17ce 2019-05-22 stsp .Pp
1404 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1405 e70c17ce 2019-05-22 stsp .Pp
1406 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1407 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1408 fa6e0e48 2019-05-23 stsp .Pp
1409 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1410 fa6e0e48 2019-05-23 stsp .Pp
1411 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1412 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1413 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1414 fa6e0e48 2019-05-23 stsp .Pp
1415 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
1416 fa6e0e48 2019-05-23 stsp .Pp
1417 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1418 e70c17ce 2019-05-22 stsp .Pp
1419 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1420 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1421 e70c17ce 2019-05-22 stsp .Pp
1422 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1423 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1424 e70c17ce 2019-05-22 stsp .Pp
1425 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1426 95fc3404 2019-07-15 stsp .Pp
1427 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1428 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1429 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1430 95fc3404 2019-07-15 stsp .Pp
1431 95fc3404 2019-07-15 stsp .Dl $ got update
1432 ac90e726 2019-07-15 stsp .Pp
1433 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1434 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1435 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1436 e70c17ce 2019-05-22 stsp .Pp
1437 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1438 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1439 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1440 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1441 ac90e726 2019-07-15 stsp .Pp
1442 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
1443 9221fb1e 2019-06-26 stsp This step currently requires
1444 9221fb1e 2019-06-26 stsp .Xr git 1 :
1445 fa6e0e48 2019-05-23 stsp .Pp
1446 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1447 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
1448 fa6e0e48 2019-05-23 stsp .Pp
1449 fa6e0e48 2019-05-23 stsp Rebase the
1450 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1451 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1452 fa6e0e48 2019-05-23 stsp .Dq master
1453 fa6e0e48 2019-05-23 stsp branch.
1454 fa6e0e48 2019-05-23 stsp .Pp
1455 818c7501 2019-07-11 stsp .Dl $ got update -b master
1456 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1457 7d7ffedb 2019-07-14 stsp .Pp
1458 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1459 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1460 1dd86744 2019-08-12 anthony .Ox Ns 's
1461 1dd86744 2019-08-12 anthony CVS tree:
1462 7d7ffedb 2019-07-14 stsp .Pp
1463 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1464 7d7ffedb 2019-07-14 stsp .Pp
1465 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1466 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1467 0ebf8283 2019-07-24 stsp branch:
1468 0ebf8283 2019-07-24 stsp .Pp
1469 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1470 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1471 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1472 ff2cf171 2019-07-28 stsp .Pp
1473 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
1474 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1475 7b3fde24 2019-07-28 stsp .Cm git fetch
1476 7b3fde24 2019-07-28 stsp and
1477 7b3fde24 2019-07-28 stsp .Cm git push .
1478 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1479 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
1480 ff2cf171 2019-07-28 stsp a Git
1481 ff2cf171 2019-07-28 stsp .Dq refspec
1482 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1483 ff2cf171 2019-07-28 stsp into the
1484 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1485 ff2cf171 2019-07-28 stsp namespace of the local repository.
1486 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1487 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1488 ff2cf171 2019-07-28 stsp configuration variable to the value
1489 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1490 ff2cf171 2019-07-28 stsp with the
1491 ff2cf171 2019-07-28 stsp .Cm git config
1492 ff2cf171 2019-07-28 stsp command:
1493 ff2cf171 2019-07-28 stsp .Pp
1494 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1495 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1496 ff2cf171 2019-07-28 stsp .Pp
1497 ff2cf171 2019-07-28 stsp Alternatively, the following
1498 ff2cf171 2019-07-28 stsp .Pa fetch
1499 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1500 ff2cf171 2019-07-28 stsp .Pa config
1501 ff2cf171 2019-07-28 stsp file:
1502 0ebf8283 2019-07-24 stsp .Pp
1503 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1504 ff2cf171 2019-07-28 stsp .Dl url = ...
1505 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1506 ff2cf171 2019-07-28 stsp .Pp
1507 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1508 ff2cf171 2019-07-28 stsp .Dq refs/heads
1509 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1510 ff2cf171 2019-07-28 stsp .Cm got checkout
1511 ff2cf171 2019-07-28 stsp and, if needed, created with
1512 ff2cf171 2019-07-28 stsp .Cm got branch .
1513 ff2cf171 2019-07-28 stsp .Pp
1514 ff2cf171 2019-07-28 stsp Branches in the
1515 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1516 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
1517 ff2cf171 2019-07-28 stsp repository with
1518 ff2cf171 2019-07-28 stsp .Cm git fetch :
1519 ff2cf171 2019-07-28 stsp .Pp
1520 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1521 ff2cf171 2019-07-28 stsp .Dl $ git fetch
1522 ff2cf171 2019-07-28 stsp .Pp
1523 ff2cf171 2019-07-28 stsp Before outgoing changes on the local
1524 ff2cf171 2019-07-28 stsp .Dq master
1525 ff2cf171 2019-07-28 stsp branch can be pushed to the remote repository, the local
1526 ff2cf171 2019-07-28 stsp .Dq master
1527 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1528 ff2cf171 2019-07-28 stsp .Dq origin/master
1529 ff2cf171 2019-07-28 stsp branch:
1530 ff2cf171 2019-07-28 stsp .Pp
1531 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1532 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1533 ff2cf171 2019-07-28 stsp .Pp
1534 ff2cf171 2019-07-28 stsp Changes on the local
1535 ff2cf171 2019-07-28 stsp .Dq master
1536 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1537 ff2cf171 2019-07-28 stsp repository with
1538 ff2cf171 2019-07-28 stsp .Cm git push :
1539 ff2cf171 2019-07-28 stsp .Pp
1540 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1541 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1542 14c25ea2 2019-10-15 stsp .Pp
1543 14c25ea2 2019-10-15 stsp In order to merge changes committed to the
1544 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1545 14c25ea2 2019-10-15 stsp branch back into the
1546 14c25ea2 2019-10-15 stsp .Dq master
1547 14c25ea2 2019-10-15 stsp branch, the
1548 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1549 14c25ea2 2019-10-15 stsp branch must first be rebased onto the
1550 14c25ea2 2019-10-15 stsp .Dq master
1551 14c25ea2 2019-10-15 stsp branch:
1552 14c25ea2 2019-10-15 stsp .Pp
1553 14c25ea2 2019-10-15 stsp .Dl $ got update -b master
1554 14c25ea2 2019-10-15 stsp .Dl $ got rebase unified-buffer-cache
1555 14c25ea2 2019-10-15 stsp .Pp
1556 14c25ea2 2019-10-15 stsp Changes on the
1557 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1558 14c25ea2 2019-10-15 stsp branch can now be made visible on the
1559 14c25ea2 2019-10-15 stsp .Dq master
1560 14c25ea2 2019-10-15 stsp branch with
1561 14c25ea2 2019-10-15 stsp .Cm got integrate .
1562 14c25ea2 2019-10-15 stsp Because the rebase operation switched the work tree to the
1563 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1564 14c25ea2 2019-10-15 stsp branch, the work tree must be switched back to the
1565 14c25ea2 2019-10-15 stsp .Dq master
1566 14c25ea2 2019-10-15 stsp branch before the
1567 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1568 14c25ea2 2019-10-15 stsp branch can be integrated into
1569 14c25ea2 2019-10-15 stsp .Dq master :
1570 14c25ea2 2019-10-15 stsp .Pp
1571 14c25ea2 2019-10-15 stsp .Dl $ got update -b master
1572 14c25ea2 2019-10-15 stsp .Dl $ got integrate unified-buffer-cache
1573 14c25ea2 2019-10-15 stsp .Pp
1574 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1575 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1576 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1577 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1578 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1579 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1580 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1581 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1582 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1583 fa6e0e48 2019-05-23 stsp .Nm
1584 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1585 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1586 fa6e0e48 2019-05-23 stsp .Xr git 1
1587 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1588 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.