Blame


1 5c860e29 2018-03-12 stsp .\"
2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5aa81393 2020-01-06 stsp .\" Copyright (c) 2018, 2019, 2020 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 83cd27f8 2020-01-13 stsp .It Fl V, -version
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 4ba14133 2020-03-20 stsp .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl q Oc Oo Fl v Oc Ar repository-URL Op Ar directory
140 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
141 2ab43947 2020-03-18 stsp .Ar repository-URL
142 2ab43947 2020-03-18 stsp into the specified
143 3493b628 2020-03-20 stsp .Ar directory .
144 2ab43947 2020-03-18 stsp If no
145 3493b628 2020-03-20 stsp .Ar directory
146 2ab43947 2020-03-18 stsp is specified the directory name will be derived from the name of the
147 2ab43947 2020-03-18 stsp cloned repository.
148 2ab43947 2020-03-18 stsp .Cm got clone
149 2ab43947 2020-03-18 stsp will refuse to run if the
150 3493b628 2020-03-20 stsp .Ar directory
151 2ab43947 2020-03-18 stsp already exists.
152 2ab43947 2020-03-18 stsp .Pp
153 2ab43947 2020-03-18 stsp The
154 2ab43947 2020-03-18 stsp .Ar repository-URL
155 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
156 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
157 619eb6dd 2020-03-20 stsp the server:
158 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
159 2ab43947 2020-03-18 stsp .Pp
160 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
161 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
162 2ab43947 2020-03-18 stsp .It git
163 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
164 2ab43947 2020-03-18 stsp .Xr git-daemon 1
165 2ab43947 2020-03-18 stsp server.
166 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
167 10c073e7 2020-03-20 stsp nor encryption.
168 2ab43947 2020-03-18 stsp .It git+ssh
169 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
170 2ab43947 2020-03-18 stsp .Xr ssh 1
171 2ab43947 2020-03-18 stsp tunnel.
172 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
173 2ab43947 2020-03-18 stsp .Xr ssh 1
174 2ab43947 2020-03-18 stsp to use:
175 2ab43947 2020-03-18 stsp .Mt user@hostname
176 2ab43947 2020-03-18 stsp .It ssh
177 2ab43947 2020-03-18 stsp Short alias for git+ssh.
178 2ab43947 2020-03-18 stsp .El
179 89c3c67b 2020-03-20 stsp .Pp
180 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
181 89c3c67b 2020-03-20 stsp from the server.
182 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
183 89c3c67b 2020-03-20 stsp within.
184 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
185 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
186 89c3c67b 2020-03-20 stsp This can take some time.
187 010f7279 2020-03-20 stsp More details about the pack file format are documented in
188 010f7279 2020-03-20 stsp .Xr git-repository 5 .
189 2ab43947 2020-03-18 stsp .Pp
190 7848a0e1 2020-03-19 stsp .Cm got clone
191 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
192 7848a0e1 2020-03-19 stsp .Pa config
193 7848a0e1 2020-03-19 stsp file of the cloned repository to store the
194 7848a0e1 2020-03-19 stsp .Ar repository-url
195 7848a0e1 2020-03-19 stsp for future use by
196 7848a0e1 2020-03-19 stsp .Cm got fetch
197 7848a0e1 2020-03-19 stsp and
198 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
199 7848a0e1 2020-03-19 stsp .Pp
200 2ab43947 2020-03-18 stsp The options for
201 2ab43947 2020-03-18 stsp .Cm got clone
202 2ab43947 2020-03-18 stsp are as follows:
203 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
204 659e7fbd 2020-03-20 stsp .It Fl a
205 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
206 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
207 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
208 4ba14133 2020-03-20 stsp Cannot be used together with the
209 4ba14133 2020-03-20 stsp .Fl b
210 4ba14133 2020-03-20 stsp option.
211 4ba14133 2020-03-20 stsp .It Fl b Ar branch
212 4ba14133 2020-03-20 stsp Fetch the specified
213 4ba14133 2020-03-20 stsp .Ar branch
214 4ba14133 2020-03-20 stsp from the remote repository.
215 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
216 4ba14133 2020-03-20 stsp to fetch.
217 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
218 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
219 4ba14133 2020-03-20 stsp branch which was fetched.
220 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
221 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
222 4ba14133 2020-03-20 stsp Cannot be used together with the
223 4ba14133 2020-03-20 stsp .Fl a
224 4ba14133 2020-03-20 stsp option.
225 469dd726 2020-03-20 stsp .It Fl m
226 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
227 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
228 469dd726 2020-03-20 stsp local changes as created by
229 469dd726 2020-03-20 stsp .Cm got commit .
230 469dd726 2020-03-20 stsp .Pp
231 469dd726 2020-03-20 stsp The repository's
232 469dd726 2020-03-20 stsp .Pa config
233 469dd726 2020-03-20 stsp file will be set up with the
234 469dd726 2020-03-20 stsp .Dq mirror
235 469dd726 2020-03-20 stsp option enabled, such that
236 469dd726 2020-03-20 stsp .Cm got fetch
237 469dd726 2020-03-20 stsp or
238 469dd726 2020-03-20 stsp .Xr git-fetch 1
239 469dd726 2020-03-20 stsp will write incoming changes directly to branches in the
240 469dd726 2020-03-20 stsp .Dq refs/heads/
241 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
242 469dd726 2020-03-20 stsp .Dq refs/remotes/
243 469dd726 2020-03-20 stsp namespace.
244 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
245 469dd726 2020-03-20 stsp .Cm got rebase
246 469dd726 2020-03-20 stsp after
247 469dd726 2020-03-20 stsp .Cm got fetch
248 469dd726 2020-03-20 stsp in order to make incoming changes appear on branches in the
249 469dd726 2020-03-20 stsp .Dq refs/heads/
250 469dd726 2020-03-20 stsp namespace.
251 469dd726 2020-03-20 stsp But maintaining custom branches with local changes in the cloned
252 469dd726 2020-03-20 stsp repository becomes difficult since local changes are at risk of
253 469dd726 2020-03-20 stsp being discarded whenever incoming changes are fetched.
254 2ab43947 2020-03-18 stsp .It Fl q
255 2ab43947 2020-03-18 stsp Suppress progress reporting output.
256 2ab43947 2020-03-18 stsp The same option will be passed to
257 2ab43947 2020-03-18 stsp .Xr ssh 1
258 2ab43947 2020-03-18 stsp if applicable.
259 2ab43947 2020-03-18 stsp .It Fl v
260 2ab43947 2020-03-18 stsp Increase the verbosity of progress reporting output.
261 2ab43947 2020-03-18 stsp The same option will be passed to
262 2ab43947 2020-03-18 stsp .Xr ssh 1
263 2ab43947 2020-03-18 stsp if applicable.
264 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
265 2ab43947 2020-03-18 stsp The maximum is 3.
266 2ab43947 2020-03-18 stsp .El
267 267fe567 2020-03-18 stsp .It Cm cl
268 267fe567 2020-03-18 stsp Short alias for
269 267fe567 2020-03-18 stsp .Cm clone .
270 4ba14133 2020-03-20 stsp .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository
271 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
272 7848a0e1 2020-03-19 stsp If no
273 4ba14133 2020-03-20 stsp .Ar remote-repository
274 4ba14133 2020-03-20 stsp is specified,
275 7848a0e1 2020-03-19 stsp .Dq origin
276 7848a0e1 2020-03-19 stsp will be used.
277 7848a0e1 2020-03-19 stsp The remote repository's URL is obtained from the corresponding entry in the
278 7848a0e1 2020-03-19 stsp .Pa config
279 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
280 7848a0e1 2020-03-19 stsp .Cm got clone .
281 7848a0e1 2020-03-19 stsp .Pp
282 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
283 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
284 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
285 89c3c67b 2020-03-20 stsp .Pp
286 7848a0e1 2020-03-19 stsp Branch references in the
287 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
288 469dd726 2020-03-20 stsp reference namespace will be updated to point at the newly fetched commits,
289 469dd726 2020-03-20 stsp and the
290 7848a0e1 2020-03-19 stsp .Cm got rebase
291 7848a0e1 2020-03-19 stsp command can then be used to make new changes visible on branches in the
292 7848a0e1 2020-03-19 stsp .Dq refs/heads/
293 469dd726 2020-03-20 stsp reference namespace, merging incoming changes with local changes as necessary.
294 7848a0e1 2020-03-19 stsp .Pp
295 469dd726 2020-03-20 stsp However, if the repository is configured as a mirror then all references will
296 469dd726 2020-03-20 stsp be updated as needed to match the corresponding references in the remote
297 469dd726 2020-03-20 stsp repository, including branches in the
298 469dd726 2020-03-20 stsp .Dq refs/heads/
299 469dd726 2020-03-20 stsp reference namespace.
300 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
301 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
302 175367bd 2020-03-20 stsp by Git's garbage collector.
303 469dd726 2020-03-20 stsp .Pp
304 469dd726 2020-03-20 stsp In any case, existing references in the
305 7848a0e1 2020-03-19 stsp .Dq refs/tags/
306 469dd726 2020-03-20 stsp namespace will always be changed to match tags contained in the remote
307 469dd726 2020-03-20 stsp repository.
308 7848a0e1 2020-03-19 stsp .Pp
309 7848a0e1 2020-03-19 stsp The options for
310 7848a0e1 2020-03-19 stsp .Cm got fetch
311 7848a0e1 2020-03-19 stsp are as follows:
312 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
313 659e7fbd 2020-03-20 stsp .It Fl a
314 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
315 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
316 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
317 4ba14133 2020-03-20 stsp Cannot be used together with the
318 4ba14133 2020-03-20 stsp .Fl b
319 4ba14133 2020-03-20 stsp option.
320 4ba14133 2020-03-20 stsp .It Fl b Ar branch
321 4ba14133 2020-03-20 stsp Fetch the specified
322 4ba14133 2020-03-20 stsp .Ar branch
323 4ba14133 2020-03-20 stsp from the remote repository.
324 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
325 4ba14133 2020-03-20 stsp to fetch.
326 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
327 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
328 4ba14133 2020-03-20 stsp Cannot be used together with the
329 4ba14133 2020-03-20 stsp .Fl a
330 4ba14133 2020-03-20 stsp option.
331 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
332 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
333 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
334 7848a0e1 2020-03-19 stsp working directory.
335 7848a0e1 2020-03-19 stsp If this directory is a
336 7848a0e1 2020-03-19 stsp .Nm
337 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
338 7848a0e1 2020-03-19 stsp .It Fl q
339 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
340 7848a0e1 2020-03-19 stsp The same option will be passed to
341 7848a0e1 2020-03-19 stsp .Xr ssh 1
342 7848a0e1 2020-03-19 stsp if applicable.
343 7848a0e1 2020-03-19 stsp .It Fl v
344 7848a0e1 2020-03-19 stsp Increase the verbosity of progress reporting output.
345 7848a0e1 2020-03-19 stsp The same option will be passed to
346 7848a0e1 2020-03-19 stsp .Xr ssh 1
347 7848a0e1 2020-03-19 stsp if applicable.
348 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
349 7848a0e1 2020-03-19 stsp The maximum is 3.
350 7848a0e1 2020-03-19 stsp .El
351 7848a0e1 2020-03-19 stsp .It Cm fe
352 7848a0e1 2020-03-19 stsp Short alias for
353 7848a0e1 2020-03-19 stsp .Cm fetch .
354 74daf7cb 2020-01-27 stsp .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
355 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
356 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
357 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
358 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
359 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
360 bb51a5b4 2020-01-13 stsp .El
361 bb51a5b4 2020-01-13 stsp .Pp
362 5d7c1dab 2018-04-01 stsp If the
363 5d7c1dab 2018-04-01 stsp .Ar work tree path
364 c844a238 2019-02-06 stsp is not specified, either use the last component of
365 5d7c1dab 2018-04-01 stsp .Ar repository path ,
366 5d7c1dab 2018-04-01 stsp or if a
367 5d7c1dab 2018-04-01 stsp .Ar path prefix
368 c844a238 2019-02-06 stsp was specified use the last component of
369 5d7c1dab 2018-04-01 stsp .Ar path prefix .
370 38e11793 2018-06-13 stsp .Pp
371 38e11793 2018-06-13 stsp The options for
372 38e11793 2018-06-13 stsp .Cm got checkout
373 38e11793 2018-06-13 stsp are as follows:
374 38e11793 2018-06-13 stsp .Bl -tag -width Ds
375 bb51a5b4 2020-01-13 stsp .It Fl E
376 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
377 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
378 bb51a5b4 2020-01-13 stsp is not empty.
379 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
380 08573d5b 2019-05-14 stsp .It Fl b Ar branch
381 3c575567 2019-07-28 stsp Check out files from a commit on the specified
382 08573d5b 2019-05-14 stsp .Ar branch .
383 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
384 08573d5b 2019-05-14 stsp reference will be used.
385 8069f636 2019-01-12 stsp .It Fl c Ar commit
386 8069f636 2019-01-12 stsp Check out files from the specified
387 3c575567 2019-07-28 stsp .Ar commit
388 3c575567 2019-07-28 stsp on the selected branch.
389 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
390 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
391 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
392 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
393 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
394 08573d5b 2019-05-14 stsp branch will be used.
395 4b6c9460 2020-03-05 stsp .Pp
396 4b6c9460 2020-03-05 stsp If the specified
397 4b6c9460 2020-03-05 stsp .Ar commit
398 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
399 4b6c9460 2020-03-05 stsp this commit must be specified with the
400 4b6c9460 2020-03-05 stsp .Fl b
401 4b6c9460 2020-03-05 stsp option.
402 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
403 4b6c9460 2020-03-05 stsp commit with
404 4b6c9460 2020-03-05 stsp .Cm got branch
405 4b6c9460 2020-03-05 stsp before
406 4b6c9460 2020-03-05 stsp .Cm got checkout
407 4b6c9460 2020-03-05 stsp can be used.
408 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
409 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
410 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
411 38e11793 2018-06-13 stsp Only files beneath the specified
412 38e11793 2018-06-13 stsp .Ar path-prefix
413 38e11793 2018-06-13 stsp will be checked out.
414 38e11793 2018-06-13 stsp .El
415 97b3a7be 2019-07-09 stsp .It Cm co
416 97b3a7be 2019-07-09 stsp Short alias for
417 97b3a7be 2019-07-09 stsp .Cm checkout .
418 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
419 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
420 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
421 7f838b36 2019-02-08 stsp .Bl -column YXZ description
422 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
423 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
424 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
425 7f838b36 2019-02-08 stsp .It D Ta file was deleted
426 7f838b36 2019-02-08 stsp .It A Ta new file was added
427 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
428 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
429 7f838b36 2019-02-08 stsp .El
430 7f838b36 2019-02-08 stsp .Pp
431 f2ea84fa 2019-07-27 stsp If no
432 c4cdcb68 2019-04-03 stsp .Ar path
433 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
434 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
435 f2ea84fa 2019-07-27 stsp specified paths.
436 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
437 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
438 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
439 f2cf8fbb 2019-04-04 stsp Some
440 f2cf8fbb 2019-04-04 stsp .Nm
441 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
442 c4cdcb68 2019-04-03 stsp multiple base commits.
443 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
444 47ec7be7 2019-05-12 stsp .Cm got update
445 47ec7be7 2019-05-12 stsp across the entire work tree.
446 024e9686 2019-05-14 stsp Specifying a
447 024e9686 2019-05-14 stsp .Ar path
448 024e9686 2019-05-14 stsp is incompatible with the
449 024e9686 2019-05-14 stsp .Fl b
450 024e9686 2019-05-14 stsp option.
451 7f838b36 2019-02-08 stsp .Pp
452 4ed9f614 2019-08-04 stsp .Cm got update
453 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
454 4ed9f614 2019-08-04 stsp If changes have been staged with
455 4ed9f614 2019-08-04 stsp .Cm got stage ,
456 bc3056e3 2019-08-18 stsp these changes must first be committed with
457 4ed9f614 2019-08-04 stsp .Cm got commit
458 4ed9f614 2019-08-04 stsp or unstaged with
459 4ed9f614 2019-08-04 stsp .Cm got unstage .
460 4ed9f614 2019-08-04 stsp .Pp
461 507dc3bb 2018-12-29 stsp The options for
462 507dc3bb 2018-12-29 stsp .Cm got update
463 507dc3bb 2018-12-29 stsp are as follows:
464 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
465 024e9686 2019-05-14 stsp .It Fl b Ar branch
466 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
467 024e9686 2019-05-14 stsp .Ar branch
468 024e9686 2019-05-14 stsp before updating the work tree.
469 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
470 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
471 507dc3bb 2018-12-29 stsp Update the work tree to the specified
472 507dc3bb 2018-12-29 stsp .Ar commit .
473 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
474 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
475 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
476 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
477 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
478 024e9686 2019-05-14 stsp branch will be used.
479 507dc3bb 2018-12-29 stsp .El
480 97b3a7be 2019-07-09 stsp .It Cm up
481 97b3a7be 2019-07-09 stsp Short alias for
482 97b3a7be 2019-07-09 stsp .Cm update .
483 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
484 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
485 6bad629b 2019-02-04 stsp using the following status codes:
486 6bad629b 2019-02-04 stsp .Bl -column YXZ description
487 6bad629b 2019-02-04 stsp .It M Ta modified file
488 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
489 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
490 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
491 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
492 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
493 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
494 6bad629b 2019-02-04 stsp .Nm
495 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
496 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
497 2a06fe5f 2019-08-24 stsp .Ar path
498 2a06fe5f 2019-08-24 stsp specified on the command line
499 6bad629b 2019-02-04 stsp .El
500 6bad629b 2019-02-04 stsp .Pp
501 72ea6654 2019-07-27 stsp If no
502 927df6b7 2019-02-10 stsp .Ar path
503 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
504 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
505 4ed9f614 2019-08-04 stsp .Pp
506 4ed9f614 2019-08-04 stsp If changes have been staged with
507 4ed9f614 2019-08-04 stsp .Cm got stage ,
508 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
509 4ed9f614 2019-08-04 stsp status codes:
510 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
511 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
512 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
513 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
514 4ed9f614 2019-08-04 stsp .El
515 4ed9f614 2019-08-04 stsp .Pp
516 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
517 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
518 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
519 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
520 4ed9f614 2019-08-04 stsp .El
521 6841da00 2019-08-08 stsp .Pp
522 6841da00 2019-08-08 stsp For compatibility with
523 bd8de430 2019-10-04 stsp .Xr cvs 1
524 bd8de430 2019-10-04 stsp and
525 bd8de430 2019-10-04 stsp .Xr git 1 ,
526 6841da00 2019-08-08 stsp .Cm got status
527 bd8de430 2019-10-04 stsp reads
528 bd8de430 2019-10-04 stsp .Xr glob 7
529 bd8de430 2019-10-04 stsp patterns from
530 6841da00 2019-08-08 stsp .Pa .cvsignore
531 bd8de430 2019-10-04 stsp and
532 bd8de430 2019-10-04 stsp .Pa .gitignore
533 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
534 bd8de430 2019-10-04 stsp which match these patterns.
535 bd8de430 2019-10-04 stsp As an extension to
536 6841da00 2019-08-08 stsp .Xr glob 7
537 bd8de430 2019-10-04 stsp matching rules,
538 bd8de430 2019-10-04 stsp .Cm got status
539 bd8de430 2019-10-04 stsp supports consecutive asterisks,
540 bd8de430 2019-10-04 stsp .Dq ** ,
541 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
542 6841da00 2019-08-08 stsp Unlike
543 6841da00 2019-08-08 stsp .Xr cvs 1 ,
544 6841da00 2019-08-08 stsp .Cm got status
545 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
546 bd8de430 2019-10-04 stsp Unlike
547 bd8de430 2019-10-04 stsp .Xr git 1 ,
548 bd8de430 2019-10-04 stsp .Cm got status
549 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
550 bd8de430 2019-10-04 stsp .Dq \&! ,
551 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
552 bd8de430 2019-10-04 stsp .Dq / ,
553 bd8de430 2019-10-04 stsp in a pattern.
554 97b3a7be 2019-07-09 stsp .It Cm st
555 97b3a7be 2019-07-09 stsp Short alias for
556 97b3a7be 2019-07-09 stsp .Cm status .
557 48c8c60d 2020-01-27 stsp .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Op Ar path
558 38e11793 2018-06-13 stsp Display history of a repository.
559 04ca23f4 2018-07-16 stsp If a
560 04ca23f4 2018-07-16 stsp .Ar path
561 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
562 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
563 dc990cbf 2020-02-22 stsp .Ar path
564 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
565 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
566 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
567 38e11793 2018-06-13 stsp .Pp
568 38e11793 2018-06-13 stsp The options for
569 38e11793 2018-06-13 stsp .Cm got log
570 38e11793 2018-06-13 stsp are as follows:
571 38e11793 2018-06-13 stsp .Bl -tag -width Ds
572 48c8c60d 2020-01-27 stsp .It Fl b
573 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
574 1137e0ae 2020-01-27 stsp from other branches.
575 48c8c60d 2020-01-27 stsp By default,
576 48c8c60d 2020-01-27 stsp .Cm got log
577 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
578 38e11793 2018-06-13 stsp .It Fl c Ar commit
579 38e11793 2018-06-13 stsp Start traversing history at the specified
580 38e11793 2018-06-13 stsp .Ar commit .
581 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
582 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
583 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
584 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
585 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
586 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
587 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
588 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
589 c0cc5c62 2018-10-18 stsp .Fl p .
590 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
591 6238ee32 2018-06-13 stsp .It Fl l Ar N
592 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
593 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
594 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
595 b1ebc001 2019-08-13 stsp The
596 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
597 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
598 6238ee32 2018-06-13 stsp .It Fl p
599 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
600 44392932 2019-08-25 stsp If a
601 44392932 2019-08-25 stsp .Ar path
602 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
603 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
604 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
605 6841bf13 2019-11-29 kn regular expression
606 6841bf13 2019-11-29 kn .Ar search-pattern .
607 6841bf13 2019-11-29 kn Regular expression syntax is documented in
608 6841bf13 2019-11-29 kn .Xr re_format 7 .
609 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
610 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
611 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
612 04ca23f4 2018-07-16 stsp working directory.
613 e9cf2e30 2019-02-05 stsp If this directory is a
614 e9cf2e30 2019-02-05 stsp .Nm
615 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
616 38e11793 2018-06-13 stsp .El
617 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
618 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
619 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
620 927df6b7 2019-02-10 stsp If a
621 927df6b7 2019-02-10 stsp .Ar path
622 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
623 927df6b7 2019-02-10 stsp .Pp
624 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
625 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
626 d24820bf 2019-08-11 stsp corresponding objects.
627 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
628 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
629 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
630 c0cc5c62 2018-10-18 stsp .Pp
631 c0cc5c62 2018-10-18 stsp The options for
632 c0cc5c62 2018-10-18 stsp .Cm got diff
633 c0cc5c62 2018-10-18 stsp are as follows:
634 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
635 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
636 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
637 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
638 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
639 b72f483a 2019-02-05 stsp Use the repository at the specified path.
640 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
641 b72f483a 2019-02-05 stsp working directory.
642 b72f483a 2019-02-05 stsp If this directory is a
643 b72f483a 2019-02-05 stsp .Nm
644 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
645 4ed9f614 2019-08-04 stsp .It Fl s
646 4ed9f614 2019-08-04 stsp Show changes staged with
647 4ed9f614 2019-08-04 stsp .Cm got stage
648 4ed9f614 2019-08-04 stsp instead of showing local changes.
649 4ed9f614 2019-08-04 stsp This option is only valid when
650 4ed9f614 2019-08-04 stsp .Cm got diff
651 4ed9f614 2019-08-04 stsp is invoked in a work tree.
652 63035f9f 2019-10-06 stsp .It Fl w
653 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
654 c0cc5c62 2018-10-18 stsp .El
655 bc26cce8 2019-08-04 stsp .It Cm di
656 bc26cce8 2019-08-04 stsp Short alias for
657 bc26cce8 2019-08-04 stsp .Cm diff .
658 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
659 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
660 1ff8e573 2018-08-02 stsp .Pp
661 1ff8e573 2018-08-02 stsp The options for
662 1ff8e573 2018-08-02 stsp .Cm got blame
663 1ff8e573 2018-08-02 stsp are as follows:
664 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
665 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
666 1ff8e573 2018-08-02 stsp Start traversing history at the specified
667 1ff8e573 2018-08-02 stsp .Ar commit .
668 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
669 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
670 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
671 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
672 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
673 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
674 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
675 1ff8e573 2018-08-02 stsp working directory.
676 0c06baac 2019-02-05 stsp If this directory is a
677 0c06baac 2019-02-05 stsp .Nm
678 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
679 5c860e29 2018-03-12 stsp .El
680 bc26cce8 2019-08-04 stsp .It Cm bl
681 bc26cce8 2019-08-04 stsp Short alias for
682 bc26cce8 2019-08-04 stsp .Cm blame .
683 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
684 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
685 5de5890b 2018-10-18 stsp directory path in the repository.
686 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
687 db0c2996 2019-02-10 stsp annotations:
688 db0c2996 2019-02-10 stsp .Bl -column YXZ description
689 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
690 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
691 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
692 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
693 db0c2996 2019-02-10 stsp .El
694 db0c2996 2019-02-10 stsp .Pp
695 0c849583 2019-02-05 stsp If no
696 0c849583 2019-02-05 stsp .Ar path
697 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
698 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
699 0c849583 2019-02-05 stsp if there is no work tree.
700 5de5890b 2018-10-18 stsp .Pp
701 5de5890b 2018-10-18 stsp The options for
702 5de5890b 2018-10-18 stsp .Cm got tree
703 5de5890b 2018-10-18 stsp are as follows:
704 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
705 5de5890b 2018-10-18 stsp .It Fl c Ar commit
706 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
707 5de5890b 2018-10-18 stsp .Ar commit .
708 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
709 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
710 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
711 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
712 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
713 5de5890b 2018-10-18 stsp Use the repository at the specified path.
714 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
715 5de5890b 2018-10-18 stsp working directory.
716 0c849583 2019-02-05 stsp If this directory is a
717 0c849583 2019-02-05 stsp .Nm
718 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
719 5de5890b 2018-10-18 stsp .It Fl i
720 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
721 c1669e2e 2019-01-09 stsp .It Fl R
722 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
723 d0eebce4 2019-03-11 stsp .El
724 bc26cce8 2019-08-04 stsp .It Cm tr
725 bc26cce8 2019-08-04 stsp Short alias for
726 bc26cce8 2019-08-04 stsp .Cm tree .
727 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
728 d0eebce4 2019-03-11 stsp Manage references in a repository.
729 d0eebce4 2019-03-11 stsp .Pp
730 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
731 d0eebce4 2019-03-11 stsp or update, the reference with the given
732 d0eebce4 2019-03-11 stsp .Ar name ,
733 d0eebce4 2019-03-11 stsp and make it point at the given
734 d83d9d5c 2019-05-13 stsp .Ar target .
735 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
736 f16e4044 2019-10-09 stsp .Dq refs/ .
737 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
738 a54b6686 2019-06-28 stsp will be resolved to an object ID.
739 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
740 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
741 d0eebce4 2019-03-11 stsp .Pp
742 d0eebce4 2019-03-11 stsp The options for
743 d0eebce4 2019-03-11 stsp .Cm got ref
744 d0eebce4 2019-03-11 stsp are as follows:
745 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
746 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
747 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
748 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
749 d0eebce4 2019-03-11 stsp working directory.
750 d0eebce4 2019-03-11 stsp If this directory is a
751 d0eebce4 2019-03-11 stsp .Nm
752 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
753 d0eebce4 2019-03-11 stsp .It Fl l
754 d0eebce4 2019-03-11 stsp List all existing references in the repository.
755 d0eebce4 2019-03-11 stsp .It Fl d Ar name
756 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
757 d1c1ae5f 2019-08-12 stsp .It Fl s
758 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
759 d1c1ae5f 2019-08-12 stsp .Ar target ,
760 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
761 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
762 d1c1ae5f 2019-08-12 stsp this option is used.
763 4e759de4 2019-06-26 stsp .El
764 da76fce2 2020-02-24 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 Oo Fl n Oc Op Ar name
765 da76fce2 2020-02-24 stsp Create, list, or delete branches.
766 4e759de4 2019-06-26 stsp .Pp
767 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
768 4e759de4 2019-06-26 stsp .Dq refs/heads/
769 4e759de4 2019-06-26 stsp reference namespace.
770 4e759de4 2019-06-26 stsp The
771 4e759de4 2019-06-26 stsp .Cm got branch
772 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
773 4e759de4 2019-06-26 stsp .Pp
774 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
775 ad89fa31 2019-10-04 stsp work tree's current branch.
776 da76fce2 2020-02-24 stsp .Pp
777 a74f7e83 2019-11-10 stsp If a
778 a74f7e83 2019-11-10 stsp .Ar name
779 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
780 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
781 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
782 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
783 4e759de4 2019-06-26 stsp .Pp
784 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
785 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
786 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
787 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
788 da76fce2 2020-02-24 stsp would do.
789 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
790 da76fce2 2020-02-24 stsp .Bl -column YXZ description
791 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
792 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
793 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
794 da76fce2 2020-02-24 stsp .It D Ta file was deleted
795 da76fce2 2020-02-24 stsp .It A Ta new file was added
796 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
797 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
798 da76fce2 2020-02-24 stsp .El
799 da76fce2 2020-02-24 stsp .Pp
800 4e759de4 2019-06-26 stsp The options for
801 4e759de4 2019-06-26 stsp .Cm got branch
802 4e759de4 2019-06-26 stsp are as follows:
803 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
804 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
805 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
806 a74f7e83 2019-11-10 stsp .Ar commit .
807 a74f7e83 2019-11-10 stsp The expected
808 a74f7e83 2019-11-10 stsp .Ar commit
809 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
810 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
811 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
812 4e759de4 2019-06-26 stsp Use the repository at the specified path.
813 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
814 4e759de4 2019-06-26 stsp working directory.
815 4e759de4 2019-06-26 stsp If this directory is a
816 4e759de4 2019-06-26 stsp .Nm
817 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
818 4e759de4 2019-06-26 stsp .It Fl l
819 4e759de4 2019-06-26 stsp List all existing branches in the repository.
820 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
821 ba882ee3 2019-07-11 stsp with one the following annotations:
822 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
823 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
824 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
825 ba882ee3 2019-07-11 stsp .El
826 4e759de4 2019-06-26 stsp .It Fl d Ar name
827 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
828 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
829 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
830 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
831 ce33d90e 2019-07-14 stsp Git's garbage collector.
832 da76fce2 2020-02-24 stsp .It Fl n
833 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
834 5de5890b 2018-10-18 stsp .El
835 97b3a7be 2019-07-09 stsp .It Cm br
836 97b3a7be 2019-07-09 stsp Short alias for
837 97b3a7be 2019-07-09 stsp .Cm branch .
838 80106605 2020-02-24 stsp .It Cm tag Oo Fl c Ar commit Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name
839 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
840 8e7bd50a 2019-08-22 stsp .Pp
841 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
842 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
843 8e7bd50a 2019-08-22 stsp reference namespace.
844 8e7bd50a 2019-08-22 stsp The
845 8e7bd50a 2019-08-22 stsp .Cm got tag
846 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
847 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
848 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
849 8e7bd50a 2019-08-22 stsp .Pp
850 80106605 2020-02-24 stsp Attempt to create a tag with the given
851 8e7bd50a 2019-08-22 stsp .Ar name ,
852 8e7bd50a 2019-08-22 stsp and make this tag point at the given
853 8e7bd50a 2019-08-22 stsp .Ar commit .
854 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
855 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
856 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
857 8e7bd50a 2019-08-22 stsp .Pp
858 8e7bd50a 2019-08-22 stsp The options for
859 8e7bd50a 2019-08-22 stsp .Cm got tag
860 8e7bd50a 2019-08-22 stsp are as follows:
861 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
862 80106605 2020-02-24 stsp .It Fl c Ar commit
863 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
864 80106605 2020-02-24 stsp .Ar commit .
865 80106605 2020-02-24 stsp The expected
866 80106605 2020-02-24 stsp .Ar commit
867 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
868 80106605 2020-02-24 stsp will be resolved to a commit ID.
869 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
870 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
871 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
872 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
873 8e7bd50a 2019-08-22 stsp Without the
874 8e7bd50a 2019-08-22 stsp .Fl m
875 8e7bd50a 2019-08-22 stsp option,
876 3a62228f 2019-11-08 stsp .Cm got tag
877 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
878 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
879 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
880 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
881 8e7bd50a 2019-08-22 stsp working directory.
882 8e7bd50a 2019-08-22 stsp If this directory is a
883 8e7bd50a 2019-08-22 stsp .Nm
884 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
885 8e7bd50a 2019-08-22 stsp .It Fl l
886 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
887 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
888 8e7bd50a 2019-08-22 stsp .El
889 8e7bd50a 2019-08-22 stsp .Pp
890 8e7bd50a 2019-08-22 stsp By design, the
891 8e7bd50a 2019-08-22 stsp .Cm got tag
892 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
893 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
894 8e7bd50a 2019-08-22 stsp .Cm got ref
895 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
896 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
897 8e7bd50a 2019-08-22 stsp another repository.
898 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
899 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
900 d00136be 2019-03-26 stsp repository in the next commit.
901 4e68cba3 2019-11-23 stsp .Pp
902 4e68cba3 2019-11-23 stsp The options for
903 4e68cba3 2019-11-23 stsp .Cm got add
904 4e68cba3 2019-11-23 stsp are as follows:
905 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
906 4e68cba3 2019-11-23 stsp .It Fl R
907 4e68cba3 2019-11-23 stsp Permit recursion into directories.
908 4e68cba3 2019-11-23 stsp If this option is not specified,
909 4e68cba3 2019-11-23 stsp .Cm got add
910 4e68cba3 2019-11-23 stsp will refuse to run if a specified
911 4e68cba3 2019-11-23 stsp .Ar path
912 4e68cba3 2019-11-23 stsp is a directory.
913 022fae89 2019-12-06 tracey .It Fl I
914 022fae89 2019-12-06 tracey With -R, add files even if they match a
915 022fae89 2019-12-06 tracey .Cm got status
916 022fae89 2019-12-06 tracey ignore pattern.
917 4e68cba3 2019-11-23 stsp .El
918 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
919 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
920 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
921 2ec1f75b 2019-03-26 stsp .Pp
922 2ec1f75b 2019-03-26 stsp The options for
923 86d25a1b 2019-07-11 stsp .Cm got remove
924 2ec1f75b 2019-03-26 stsp are as follows:
925 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
926 2ec1f75b 2019-03-26 stsp .It Fl f
927 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
928 70e3e7f5 2019-12-13 tracey .It Fl k
929 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
930 f2a9dc41 2019-12-13 tracey .It Fl R
931 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
932 f2a9dc41 2019-12-13 tracey If this option is not specified,
933 f2a9dc41 2019-12-13 tracey .Cm got remove
934 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
935 f2a9dc41 2019-12-13 tracey .Ar path
936 f2a9dc41 2019-12-13 tracey is a directory.
937 d0eebce4 2019-03-11 stsp .El
938 648e4ef7 2019-07-09 stsp .It Cm rm
939 648e4ef7 2019-07-09 stsp Short alias for
940 648e4ef7 2019-07-09 stsp .Cm remove .
941 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 ...
942 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
943 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
944 1dd86744 2019-08-12 anthony work tree's base commit.
945 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
946 a129376b 2019-03-28 stsp .Cm got revert !
947 a129376b 2019-03-28 stsp .Pp
948 e20a8b6f 2019-06-04 stsp If a file was added with
949 a129376b 2019-03-28 stsp .Cm got add
950 a129376b 2019-03-28 stsp it will become an unversioned file again.
951 e20a8b6f 2019-06-04 stsp If a file was deleted with
952 86d25a1b 2019-07-11 stsp .Cm got remove
953 a129376b 2019-03-28 stsp it will be restored.
954 0f6d7415 2019-08-08 stsp .Pp
955 0f6d7415 2019-08-08 stsp The options for
956 0f6d7415 2019-08-08 stsp .Cm got revert
957 0f6d7415 2019-08-08 stsp are as follows:
958 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
959 33aa809d 2019-08-08 stsp .It Fl p
960 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
961 33aa809d 2019-08-08 stsp changes to revert based on
962 33aa809d 2019-08-08 stsp .Dq y
963 33aa809d 2019-08-08 stsp (revert change),
964 33aa809d 2019-08-08 stsp .Dq n
965 33aa809d 2019-08-08 stsp (keep change), and
966 33aa809d 2019-08-08 stsp .Dq q
967 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
968 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
969 33aa809d 2019-08-08 stsp modified file content can be reverted.
970 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
971 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
972 33aa809d 2019-08-08 stsp With the
973 33aa809d 2019-08-08 stsp .Fl p
974 33aa809d 2019-08-08 stsp option, read
975 33aa809d 2019-08-08 stsp .Dq y ,
976 33aa809d 2019-08-08 stsp .Dq n ,
977 33aa809d 2019-08-08 stsp and
978 33aa809d 2019-08-08 stsp .Dq q
979 33aa809d 2019-08-08 stsp responses line-by-line from the specified
980 33aa809d 2019-08-08 stsp .Ar response-script
981 33aa809d 2019-08-08 stsp file instead of prompting interactively.
982 0f6d7415 2019-08-08 stsp .It Fl R
983 0f6d7415 2019-08-08 stsp Permit recursion into directories.
984 0f6d7415 2019-08-08 stsp If this option is not specified,
985 0f6d7415 2019-08-08 stsp .Cm got revert
986 0f6d7415 2019-08-08 stsp will refuse to run if a specified
987 0f6d7415 2019-08-08 stsp .Ar path
988 0f6d7415 2019-08-08 stsp is a directory.
989 0f6d7415 2019-08-08 stsp .El
990 97b3a7be 2019-07-09 stsp .It Cm rv
991 97b3a7be 2019-07-09 stsp Short alias for
992 97b3a7be 2019-07-09 stsp .Cm revert .
993 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
994 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
995 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
996 5c1e53bc 2019-07-28 stsp If no
997 90e8619e 2019-07-25 stsp .Ar path
998 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
999 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1000 15cd91f7 2019-05-12 stsp .Pp
1001 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1002 1dd86744 2019-08-12 anthony .Cm got stage ,
1003 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1004 4ed9f614 2019-08-04 stsp have not been staged.
1005 4ed9f614 2019-08-04 stsp .Pp
1006 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1007 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1008 15cd91f7 2019-05-12 stsp .It M Ta modified file
1009 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1010 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1011 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1012 15cd91f7 2019-05-12 stsp .El
1013 15cd91f7 2019-05-12 stsp .Pp
1014 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1015 996d5ccd 2019-08-05 stsp recorded base commit.
1016 15cd91f7 2019-05-12 stsp Some
1017 15cd91f7 2019-05-12 stsp .Nm
1018 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1019 15cd91f7 2019-05-12 stsp multiple base commits.
1020 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1021 47ec7be7 2019-05-12 stsp .Cm got update
1022 47ec7be7 2019-05-12 stsp across the entire work tree.
1023 15cd91f7 2019-05-12 stsp .Pp
1024 15cd91f7 2019-05-12 stsp The
1025 15cd91f7 2019-05-12 stsp .Cm got commit
1026 15cd91f7 2019-05-12 stsp command requires the
1027 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1028 aba9c984 2019-09-08 stsp environment variable to be set,
1029 aba9c984 2019-09-08 stsp unless Git's
1030 aba9c984 2019-09-08 stsp .Dv user.name
1031 aba9c984 2019-09-08 stsp and
1032 709ae9eb 2019-09-08 stsp .Dv user.email
1033 709ae9eb 2019-09-08 stsp configuration settings can be
1034 aba9c984 2019-09-08 stsp obtained from the repository's
1035 aba9c984 2019-09-08 stsp .Pa .git/config
1036 c9956ddf 2019-09-08 stsp file or from Git's global
1037 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1038 c9956ddf 2019-09-08 stsp configuration file.
1039 74416c47 2019-05-09 stsp .Pp
1040 74416c47 2019-05-09 stsp The options for
1041 74416c47 2019-05-09 stsp .Cm got commit
1042 74416c47 2019-05-09 stsp are as follows:
1043 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1044 74ff3f23 2019-07-07 stsp .It Fl m Ar message
1045 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
1046 23594da9 2019-05-13 stsp Without the
1047 23594da9 2019-05-13 stsp .Fl m
1048 23594da9 2019-05-13 stsp option,
1049 23594da9 2019-05-13 stsp .Cm got commit
1050 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
1051 2ec1f75b 2019-03-26 stsp .El
1052 cfce0458 2019-07-28 stsp .Pp
1053 cfce0458 2019-07-28 stsp .Cm got commit
1054 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1055 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1056 916f288c 2019-07-30 stsp .Dq refs/heads/
1057 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1058 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1059 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1060 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1061 cfce0458 2019-07-28 stsp .Cm got update
1062 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1063 cfce0458 2019-07-28 stsp in the repository.
1064 97b3a7be 2019-07-09 stsp .It Cm ci
1065 97b3a7be 2019-07-09 stsp Short alias for
1066 97b3a7be 2019-07-09 stsp .Cm commit .
1067 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1068 234035bc 2019-06-01 stsp Merge changes from a single
1069 234035bc 2019-06-01 stsp .Ar commit
1070 234035bc 2019-06-01 stsp into the work tree.
1071 234035bc 2019-06-01 stsp The specified
1072 234035bc 2019-06-01 stsp .Ar commit
1073 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
1074 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1075 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1076 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1077 234035bc 2019-06-01 stsp .Pp
1078 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1079 234035bc 2019-06-01 stsp .Bl -column YXZ description
1080 234035bc 2019-06-01 stsp .It G Ta file was merged
1081 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1082 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1083 234035bc 2019-06-01 stsp .It D Ta file was deleted
1084 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1085 234035bc 2019-06-01 stsp .It A Ta new file was added
1086 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1087 74416c47 2019-05-09 stsp .El
1088 234035bc 2019-06-01 stsp .Pp
1089 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1090 234035bc 2019-06-01 stsp may be viewed with
1091 234035bc 2019-06-01 stsp .Cm got diff ,
1092 234035bc 2019-06-01 stsp amended manually or with further
1093 234035bc 2019-06-01 stsp .Cm got cherrypick
1094 bc3056e3 2019-08-18 stsp commands,
1095 234035bc 2019-06-01 stsp committed with
1096 234035bc 2019-06-01 stsp .Cm got commit ,
1097 234035bc 2019-06-01 stsp or discarded again with
1098 234035bc 2019-06-01 stsp .Cm got revert .
1099 234035bc 2019-06-01 stsp .Pp
1100 234035bc 2019-06-01 stsp .Cm got cherrypick
1101 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1102 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1103 234035bc 2019-06-01 stsp to a single base commit with
1104 234035bc 2019-06-01 stsp .Cm got update .
1105 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1106 234035bc 2019-06-01 stsp conflicts must be resolved first.
1107 016477fd 2019-07-09 stsp .It Cm cy
1108 97b3a7be 2019-07-09 stsp Short alias for
1109 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1110 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1111 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1112 5ef14e63 2019-06-02 stsp .Ar commit
1113 5ef14e63 2019-06-02 stsp into the work tree.
1114 5ef14e63 2019-06-02 stsp The specified
1115 5ef14e63 2019-06-02 stsp .Ar commit
1116 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
1117 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1118 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1119 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1120 5ef14e63 2019-06-02 stsp .Pp
1121 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1122 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1123 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1124 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1125 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1126 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1127 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1128 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1129 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1130 234035bc 2019-06-01 stsp .El
1131 5ef14e63 2019-06-02 stsp .Pp
1132 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1133 5ef14e63 2019-06-02 stsp which may be viewed with
1134 5ef14e63 2019-06-02 stsp .Cm got diff ,
1135 5ef14e63 2019-06-02 stsp amended manually or with further
1136 778a73c2 2019-07-12 stsp .Cm got backout
1137 bc3056e3 2019-08-18 stsp commands,
1138 5ef14e63 2019-06-02 stsp committed with
1139 5ef14e63 2019-06-02 stsp .Cm got commit ,
1140 5ef14e63 2019-06-02 stsp or discarded again with
1141 5ef14e63 2019-06-02 stsp .Cm got revert .
1142 5ef14e63 2019-06-02 stsp .Pp
1143 92228c38 2019-06-02 stsp .Cm got backout
1144 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1145 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1146 92228c38 2019-06-02 stsp to a single base commit with
1147 92228c38 2019-06-02 stsp .Cm got update .
1148 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1149 92228c38 2019-06-02 stsp conflicts must be resolved first.
1150 97b3a7be 2019-07-09 stsp .It Cm bo
1151 97b3a7be 2019-07-09 stsp Short alias for
1152 97b3a7be 2019-07-09 stsp .Cm backout .
1153 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1154 818c7501 2019-07-11 stsp Rebase commits on the specified
1155 818c7501 2019-07-11 stsp .Ar branch
1156 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1157 818c7501 2019-07-11 stsp The
1158 818c7501 2019-07-11 stsp .Ar branch
1159 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1160 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1161 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1162 818c7501 2019-07-11 stsp .Ar branch
1163 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1164 f09e2405 2019-07-11 stsp of the specified
1165 818c7501 2019-07-11 stsp .Ar branch
1166 f09e2405 2019-07-11 stsp has been rebased.
1167 818c7501 2019-07-11 stsp .Pp
1168 2b6826ba 2020-02-24 stsp When
1169 2b6826ba 2020-02-24 stsp .Cm got rebase
1170 2b6826ba 2020-02-24 stsp is used as intended, the specified
1171 2b6826ba 2020-02-24 stsp .Ar branch
1172 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1173 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1174 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1175 2b6826ba 2020-02-24 stsp .Cm got update -b
1176 2b6826ba 2020-02-24 stsp before starting the
1177 2b6826ba 2020-02-24 stsp .Cm rebase
1178 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1179 2b6826ba 2020-02-24 stsp a common history with the specified
1180 2b6826ba 2020-02-24 stsp .Ar branch
1181 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1182 c10890ce 2020-02-25 stsp remote repository.
1183 2b6826ba 2020-02-24 stsp .Pp
1184 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1185 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1186 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1187 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1188 818c7501 2019-07-11 stsp .Ar branch ,
1189 818c7501 2019-07-11 stsp but with different commit IDs.
1190 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1191 f09e2405 2019-07-11 stsp the new version of the specified
1192 818c7501 2019-07-11 stsp .Ar branch
1193 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1194 818c7501 2019-07-11 stsp .Pp
1195 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1196 818c7501 2019-07-11 stsp using the following status codes:
1197 818c7501 2019-07-11 stsp .Bl -column YXZ description
1198 818c7501 2019-07-11 stsp .It G Ta file was merged
1199 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1200 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1201 818c7501 2019-07-11 stsp .It D Ta file was deleted
1202 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1203 818c7501 2019-07-11 stsp .It A Ta new file was added
1204 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1205 5ef14e63 2019-06-02 stsp .El
1206 818c7501 2019-07-11 stsp .Pp
1207 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1208 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1209 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1210 818c7501 2019-07-11 stsp .Ar branch
1211 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1212 818c7501 2019-07-11 stsp .Pp
1213 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1214 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1215 f09e2405 2019-07-11 stsp when the rebase operation continues.
1216 ff0d2220 2019-07-11 stsp .Pp
1217 818c7501 2019-07-11 stsp .Cm got rebase
1218 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1219 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1220 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1221 818c7501 2019-07-11 stsp .Cm got update .
1222 4ed9f614 2019-08-04 stsp If changes have been staged with
1223 4ed9f614 2019-08-04 stsp .Cm got stage ,
1224 bc3056e3 2019-08-18 stsp these changes must first be committed with
1225 4ed9f614 2019-08-04 stsp .Cm got commit
1226 4ed9f614 2019-08-04 stsp or unstaged with
1227 4ed9f614 2019-08-04 stsp .Cm got unstage .
1228 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1229 f09e2405 2019-07-11 stsp committed with
1230 f09e2405 2019-07-11 stsp .Cm got commit
1231 f09e2405 2019-07-11 stsp or reverted with
1232 f09e2405 2019-07-11 stsp .Cm got revert .
1233 64c6d990 2019-07-11 stsp If the
1234 64c6d990 2019-07-11 stsp .Ar branch
1235 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1236 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1237 818c7501 2019-07-11 stsp .Pp
1238 7d5807f4 2019-07-11 stsp The
1239 7d5807f4 2019-07-11 stsp .Cm got update
1240 7d5807f4 2019-07-11 stsp and
1241 7d5807f4 2019-07-11 stsp .Cm got commit
1242 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1243 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1244 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1245 818c7501 2019-07-11 stsp .Pp
1246 818c7501 2019-07-11 stsp The options for
1247 818c7501 2019-07-11 stsp .Cm got rebase
1248 818c7501 2019-07-11 stsp are as follows:
1249 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1250 818c7501 2019-07-11 stsp .It Fl a
1251 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1252 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1253 818c7501 2019-07-11 stsp .It Fl c
1254 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1255 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1256 818c7501 2019-07-11 stsp .El
1257 818c7501 2019-07-11 stsp .It Cm rb
1258 818c7501 2019-07-11 stsp Short alias for
1259 818c7501 2019-07-11 stsp .Cm rebase .
1260 083957f4 2020-02-24 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1261 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1262 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1263 6e54d307 2020-02-24 stsp .Pp
1264 6e54d307 2020-02-24 stsp Before starting a
1265 6e54d307 2020-02-24 stsp .Cm histedit
1266 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1267 6e54d307 2020-02-24 stsp .Cm got update -b
1268 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1269 6e54d307 2020-02-24 stsp current branch of the work tree.
1270 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1271 6e54d307 2020-02-24 stsp touched by the
1272 6e54d307 2020-02-24 stsp .Cm histedit
1273 6e54d307 2020-02-24 stsp operation.
1274 0ebf8283 2019-07-24 stsp .Pp
1275 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1276 6e54d307 2020-02-24 stsp must be set with
1277 6e54d307 2020-02-24 stsp .Cm got update -c
1278 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1279 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1280 6e54d307 2020-02-24 stsp by the
1281 6e54d307 2020-02-24 stsp .Cm histedit
1282 6e54d307 2020-02-24 stsp operation.
1283 6e54d307 2020-02-24 stsp .Pp
1284 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1285 0ebf8283 2019-07-24 stsp .Ar histedit script
1286 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1287 46fa4c83 2020-02-24 stsp command line, or generated with the
1288 083957f4 2020-02-24 stsp .Fl m
1289 083957f4 2020-02-24 stsp option if only log messages need to be edited.
1290 083957f4 2020-02-24 stsp .Pp
1291 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1292 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1293 0ebf8283 2019-07-24 stsp whitespace and an argument.
1294 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1295 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1296 0ebf8283 2019-07-24 stsp Lines which begin with the
1297 0ebf8283 2019-07-24 stsp .Sq #
1298 0ebf8283 2019-07-24 stsp character are ignored entirely.
1299 0ebf8283 2019-07-24 stsp .Pp
1300 0ebf8283 2019-07-24 stsp The available commands are as follows:
1301 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1302 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1303 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1304 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1305 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1306 0ebf8283 2019-07-24 stsp listed further below that will be used.
1307 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1308 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1309 0ebf8283 2019-07-24 stsp the commit on the previous line.
1310 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1311 0ebf8283 2019-07-24 stsp log message can be written.
1312 0ebf8283 2019-07-24 stsp .El
1313 0ebf8283 2019-07-24 stsp .Pp
1314 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1315 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1316 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1317 0ebf8283 2019-07-24 stsp .Pp
1318 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1319 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1320 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1321 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1322 498a90b7 2019-07-25 stsp switched to it.
1323 0ebf8283 2019-07-24 stsp .Pp
1324 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1325 0ebf8283 2019-07-24 stsp using the following status codes:
1326 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1327 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1328 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1329 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1330 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1331 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1332 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1333 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1334 0ebf8283 2019-07-24 stsp .El
1335 0ebf8283 2019-07-24 stsp .Pp
1336 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1337 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1338 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1339 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1340 0ebf8283 2019-07-24 stsp .Pp
1341 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1342 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1343 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1344 0ebf8283 2019-07-24 stsp .Pp
1345 0ebf8283 2019-07-24 stsp .Cm got histedit
1346 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1347 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1348 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1349 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1350 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1351 0ebf8283 2019-07-24 stsp to a single base commit with
1352 0ebf8283 2019-07-24 stsp .Cm got update .
1353 4ed9f614 2019-08-04 stsp If changes have been staged with
1354 4ed9f614 2019-08-04 stsp .Cm got stage ,
1355 bc3056e3 2019-08-18 stsp these changes must first be committed with
1356 4ed9f614 2019-08-04 stsp .Cm got commit
1357 4ed9f614 2019-08-04 stsp or unstaged with
1358 4ed9f614 2019-08-04 stsp .Cm got unstage .
1359 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1360 0ebf8283 2019-07-24 stsp committed with
1361 0ebf8283 2019-07-24 stsp .Cm got commit
1362 0ebf8283 2019-07-24 stsp or reverted with
1363 0ebf8283 2019-07-24 stsp .Cm got revert .
1364 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1365 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1366 0ebf8283 2019-07-24 stsp .Pp
1367 0ebf8283 2019-07-24 stsp The
1368 7ef62c4e 2020-02-24 stsp .Cm got update ,
1369 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1370 65db4ffb 2020-02-24 stsp and
1371 65db4ffb 2020-02-24 stsp .Cm got integrate
1372 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1373 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1374 0ebf8283 2019-07-24 stsp .Cm got commit
1375 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1376 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1377 0ebf8283 2019-07-24 stsp .Pp
1378 0ebf8283 2019-07-24 stsp The options for
1379 0ebf8283 2019-07-24 stsp .Cm got histedit
1380 0ebf8283 2019-07-24 stsp are as follows:
1381 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1382 0ebf8283 2019-07-24 stsp .It Fl a
1383 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1384 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1385 0ebf8283 2019-07-24 stsp .It Fl c
1386 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1387 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1388 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1389 ddbfac99 2020-02-24 stsp Use the specified
1390 ddbfac99 2020-02-24 stsp .Ar histedit-script
1391 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1392 ddbfac99 2020-02-24 stsp can be written.
1393 083957f4 2020-02-24 stsp .It Fl m
1394 083957f4 2020-02-24 stsp Edit log messages only.
1395 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1396 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1397 083957f4 2020-02-24 stsp The
1398 083957f4 2020-02-24 stsp .Fl m
1399 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1400 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1401 818c7501 2019-07-11 stsp .El
1402 0ebf8283 2019-07-24 stsp .It Cm he
1403 0ebf8283 2019-07-24 stsp Short alias for
1404 0ebf8283 2019-07-24 stsp .Cm histedit .
1405 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1406 2822a352 2019-10-15 stsp Integrate the specified
1407 2822a352 2019-10-15 stsp .Ar branch
1408 2822a352 2019-10-15 stsp into the work tree's current branch.
1409 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1410 2822a352 2019-10-15 stsp .Ar branch ,
1411 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1412 2822a352 2019-10-15 stsp head commit of the integrated
1413 2822a352 2019-10-15 stsp .Ar branch .
1414 2822a352 2019-10-15 stsp .Pp
1415 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1416 2822a352 2019-10-15 stsp will be pointing at the same commit.
1417 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1418 2822a352 2019-10-15 stsp In case the integrated
1419 2822a352 2019-10-15 stsp .Ar branch
1420 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1421 2822a352 2019-10-15 stsp .Cm got branch -d .
1422 2822a352 2019-10-15 stsp .Pp
1423 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1424 2822a352 2019-10-15 stsp .Bl -column YXZ description
1425 2822a352 2019-10-15 stsp .It U Ta file was updated
1426 2822a352 2019-10-15 stsp .It D Ta file was deleted
1427 2822a352 2019-10-15 stsp .It A Ta new file was added
1428 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1429 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1430 2822a352 2019-10-15 stsp .El
1431 2822a352 2019-10-15 stsp .Pp
1432 2822a352 2019-10-15 stsp .Cm got integrate
1433 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1434 2822a352 2019-10-15 stsp Most importantly, the
1435 2822a352 2019-10-15 stsp .Ar branch
1436 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1437 2822a352 2019-10-15 stsp .Cm got rebase
1438 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1439 2822a352 2019-10-15 stsp resolve merge conflicts.
1440 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1441 2822a352 2019-10-15 stsp to a single base commit with
1442 2822a352 2019-10-15 stsp .Cm got update .
1443 2822a352 2019-10-15 stsp If changes have been staged with
1444 2822a352 2019-10-15 stsp .Cm got stage ,
1445 2822a352 2019-10-15 stsp these changes must first be committed with
1446 2822a352 2019-10-15 stsp .Cm got commit
1447 2822a352 2019-10-15 stsp or unstaged with
1448 2822a352 2019-10-15 stsp .Cm got unstage .
1449 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1450 2822a352 2019-10-15 stsp committed with
1451 2822a352 2019-10-15 stsp .Cm got commit
1452 2822a352 2019-10-15 stsp or reverted with
1453 2822a352 2019-10-15 stsp .Cm got revert .
1454 2822a352 2019-10-15 stsp .It Cm ig
1455 2822a352 2019-10-15 stsp Short alias for
1456 2822a352 2019-10-15 stsp .Cm integrate .
1457 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 ...
1458 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1459 2db2652d 2019-08-07 stsp If no
1460 2db2652d 2019-08-07 stsp .Ar path
1461 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1462 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1463 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1464 4ed9f614 2019-08-04 stsp .Cm got status .
1465 4ed9f614 2019-08-04 stsp .Pp
1466 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1467 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1468 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1469 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1470 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1471 9d8b19a4 2019-08-04 stsp .El
1472 9d8b19a4 2019-08-04 stsp .Pp
1473 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1474 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1475 9d8b19a4 2019-08-04 stsp committed.
1476 9d8b19a4 2019-08-04 stsp .Pp
1477 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1478 4ed9f614 2019-08-04 stsp .Cm got commit ,
1479 4ed9f614 2019-08-04 stsp .Cm got status ,
1480 4ed9f614 2019-08-04 stsp and
1481 4ed9f614 2019-08-04 stsp .Cm got diff .
1482 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1483 4ed9f614 2019-08-04 stsp .Cm got commit
1484 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1485 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1486 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1487 4ed9f614 2019-08-04 stsp The
1488 4ed9f614 2019-08-04 stsp .Cm got status
1489 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1490 4ed9f614 2019-08-04 stsp The
1491 4ed9f614 2019-08-04 stsp .Cm got diff
1492 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1493 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1494 4ed9f614 2019-08-04 stsp The
1495 4ed9f614 2019-08-04 stsp .Cm got revert
1496 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1497 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1498 4ed9f614 2019-08-04 stsp .Pp
1499 4ed9f614 2019-08-04 stsp The options for
1500 4ed9f614 2019-08-04 stsp .Cm got stage
1501 4ed9f614 2019-08-04 stsp are as follows:
1502 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1503 4ed9f614 2019-08-04 stsp .It Fl l
1504 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1505 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1506 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1507 1dd86744 2019-08-12 anthony among the specified paths.
1508 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1509 dc424a06 2019-08-07 stsp .It Fl p
1510 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1511 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1512 dc424a06 2019-08-07 stsp .Dq y
1513 6d23ec10 2019-08-08 stsp (stage change),
1514 dc424a06 2019-08-07 stsp .Dq n
1515 6d23ec10 2019-08-08 stsp (reject change), and
1516 b353a198 2019-08-07 stsp .Dq q
1517 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1518 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1519 dc424a06 2019-08-07 stsp modified file content can be staged.
1520 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1521 6d23ec10 2019-08-08 stsp their entirety.
1522 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1523 dc424a06 2019-08-07 stsp With the
1524 dc424a06 2019-08-07 stsp .Fl p
1525 3a070a2b 2019-08-07 stsp option, read
1526 3a070a2b 2019-08-07 stsp .Dq y ,
1527 3a070a2b 2019-08-07 stsp .Dq n ,
1528 3a070a2b 2019-08-07 stsp and
1529 3a070a2b 2019-08-07 stsp .Dq q
1530 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1531 0e2f5884 2019-08-07 stsp .Ar response-script
1532 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1533 4ed9f614 2019-08-04 stsp .El
1534 4ed9f614 2019-08-04 stsp .Pp
1535 4ed9f614 2019-08-04 stsp .Cm got stage
1536 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1537 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1538 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1539 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1540 4ed9f614 2019-08-04 stsp .Cm got update
1541 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1542 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1543 4ed9f614 2019-08-04 stsp .Pp
1544 4ed9f614 2019-08-04 stsp The
1545 4ed9f614 2019-08-04 stsp .Cm got update ,
1546 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1547 4ed9f614 2019-08-04 stsp and
1548 4ed9f614 2019-08-04 stsp .Cm got histedit
1549 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1550 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1551 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1552 4ed9f614 2019-08-04 stsp .Cm got unstage
1553 4ed9f614 2019-08-04 stsp before it can be updated with
1554 4ed9f614 2019-08-04 stsp .Cm got update ,
1555 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1556 4ed9f614 2019-08-04 stsp .It Cm sg
1557 4ed9f614 2019-08-04 stsp Short alias for
1558 4ed9f614 2019-08-04 stsp .Cm stage .
1559 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1560 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1561 4ed9f614 2019-08-04 stsp back into non-staged status.
1562 4ed9f614 2019-08-04 stsp If no
1563 4ed9f614 2019-08-04 stsp .Ar path
1564 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1565 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1566 4ed9f614 2019-08-04 stsp .Pp
1567 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1568 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1569 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1570 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1571 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1572 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1573 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1574 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1575 4ed9f614 2019-08-04 stsp .El
1576 2e1f37b0 2019-08-08 stsp .Pp
1577 2e1f37b0 2019-08-08 stsp The options for
1578 2e1f37b0 2019-08-08 stsp .Cm got unstage
1579 2e1f37b0 2019-08-08 stsp are as follows:
1580 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1581 2e1f37b0 2019-08-08 stsp .It Fl p
1582 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1583 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1584 2e1f37b0 2019-08-08 stsp .Dq y
1585 2e1f37b0 2019-08-08 stsp (unstage change),
1586 2e1f37b0 2019-08-08 stsp .Dq n
1587 2e1f37b0 2019-08-08 stsp (keep change staged), and
1588 2e1f37b0 2019-08-08 stsp .Dq q
1589 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1590 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1591 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1592 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1593 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1594 2e1f37b0 2019-08-08 stsp With the
1595 2e1f37b0 2019-08-08 stsp .Fl p
1596 2e1f37b0 2019-08-08 stsp option, read
1597 2e1f37b0 2019-08-08 stsp .Dq y ,
1598 2e1f37b0 2019-08-08 stsp .Dq n ,
1599 2e1f37b0 2019-08-08 stsp and
1600 2e1f37b0 2019-08-08 stsp .Dq q
1601 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1602 2e1f37b0 2019-08-08 stsp .Ar response-script
1603 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1604 2e1f37b0 2019-08-08 stsp .El
1605 4ed9f614 2019-08-04 stsp .It Cm ug
1606 4ed9f614 2019-08-04 stsp Short alias for
1607 4ed9f614 2019-08-04 stsp .Cm unstage .
1608 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 ...
1609 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1610 896e9b6f 2019-08-26 stsp text format.
1611 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1612 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1613 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1614 896e9b6f 2019-08-26 stsp .Pp
1615 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1616 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1617 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1618 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1619 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1620 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1621 01073a5d 2019-08-22 stsp .Pp
1622 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1623 896e9b6f 2019-08-26 stsp .Fl P
1624 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1625 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1626 896e9b6f 2019-08-26 stsp .Pp
1627 01073a5d 2019-08-22 stsp The options for
1628 01073a5d 2019-08-22 stsp .Cm got cat
1629 01073a5d 2019-08-22 stsp are as follows:
1630 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1631 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1632 896e9b6f 2019-08-26 stsp Look up paths in the specified
1633 896e9b6f 2019-08-26 stsp .Ar commit .
1634 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1635 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1636 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1637 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1638 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1639 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1640 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1641 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1642 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1643 01073a5d 2019-08-22 stsp working directory.
1644 01073a5d 2019-08-22 stsp If this directory is a
1645 01073a5d 2019-08-22 stsp .Nm
1646 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1647 896e9b6f 2019-08-26 stsp .It Fl P
1648 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1649 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1650 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1651 4ed9f614 2019-08-04 stsp .El
1652 01073a5d 2019-08-22 stsp .El
1653 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1654 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1655 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1656 74416c47 2019-05-09 stsp The author's name and email address for
1657 21a44f98 2019-07-15 stsp .Cm got commit
1658 21a44f98 2019-07-15 stsp and
1659 21a44f98 2019-07-15 stsp .Cm got import ,
1660 74416c47 2019-05-09 stsp for example:
1661 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1662 84792843 2019-08-09 stsp Because
1663 0e444aba 2019-08-08 stsp .Xr git 1
1664 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1665 0e444aba 2019-08-08 stsp .Nm
1666 84792843 2019-08-09 stsp attempts to reject
1667 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1668 84792843 2019-08-09 stsp environment variables with a missing email address.
1669 c9956ddf 2019-09-08 stsp .Pp
1670 c9956ddf 2019-09-08 stsp If present, Git's
1671 aba9c984 2019-09-08 stsp .Dv user.name
1672 aba9c984 2019-09-08 stsp and
1673 709ae9eb 2019-09-08 stsp .Dv user.email
1674 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1675 aba9c984 2019-09-08 stsp .Pa .git/config
1676 aba9c984 2019-09-08 stsp file will override the value of
1677 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1678 c9956ddf 2019-09-08 stsp However, the
1679 c9956ddf 2019-09-08 stsp .Dv user.name
1680 c9956ddf 2019-09-08 stsp and
1681 c9956ddf 2019-09-08 stsp .Dv user.email
1682 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1683 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1684 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1685 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1686 c9956ddf 2019-09-08 stsp environment variable is
1687 c9956ddf 2019-09-08 stsp .Em not
1688 c9956ddf 2019-09-08 stsp set.
1689 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1690 23594da9 2019-05-13 stsp The editor spawned by
1691 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1692 8e7bd50a 2019-08-22 stsp .Cm got import ,
1693 8e7bd50a 2019-08-22 stsp or
1694 8e7bd50a 2019-08-22 stsp .Cm got tag .
1695 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1696 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1697 b1ebc001 2019-08-13 stsp .Cm got log .
1698 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1699 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1700 858b0dfb 2020-03-20 stsp .It Ev GOT_FETCH_DEBUG
1701 858b0dfb 2020-03-20 stsp Enables protocol tracing on standard error output during
1702 858b0dfb 2020-03-20 stsp .Cm got clone
1703 858b0dfb 2020-03-20 stsp and
1704 858b0dfb 2020-03-20 stsp .Cm got fetch .
1705 74416c47 2019-05-09 stsp .El
1706 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1707 5c860e29 2018-03-12 stsp .Ex -std got
1708 97925469 2018-03-17 stsp .Sh EXAMPLES
1709 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1710 fa6e0e48 2019-05-23 stsp .Nm .
1711 fd039d72 2020-03-18 stsp .Pp
1712 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
1713 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
1714 fd039d72 2020-03-18 stsp .Pp
1715 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
1716 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1717 d83d9d5c 2019-05-13 stsp .Pp
1718 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1719 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1720 fa6e0e48 2019-05-23 stsp .Pp
1721 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1722 3ce1b845 2019-07-15 stsp .Nm
1723 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1724 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1725 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1726 fa6e0e48 2019-05-23 stsp .Pp
1727 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1728 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1729 3ce1b845 2019-07-15 stsp .Pp
1730 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1731 3ce1b845 2019-07-15 stsp .Pp
1732 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1733 fa6e0e48 2019-05-23 stsp .Pp
1734 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1735 e70c17ce 2019-05-22 stsp .Pp
1736 e70c17ce 2019-05-22 stsp .Dl $ got status
1737 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1738 33aa809d 2019-08-08 stsp .Pp
1739 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1740 e70c17ce 2019-05-22 stsp .Pp
1741 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1742 33aa809d 2019-08-08 stsp .Pp
1743 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1744 e70c17ce 2019-05-22 stsp .Pp
1745 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1746 e70c17ce 2019-05-22 stsp .Pp
1747 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1748 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1749 d83d9d5c 2019-05-13 stsp which is forked off the
1750 d83d9d5c 2019-05-13 stsp .Dq master
1751 d83d9d5c 2019-05-13 stsp branch:
1752 d83d9d5c 2019-05-13 stsp .Pp
1753 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1754 e70c17ce 2019-05-22 stsp .Pp
1755 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1756 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1757 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1758 e70c17ce 2019-05-22 stsp .Pp
1759 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1760 e70c17ce 2019-05-22 stsp .Pp
1761 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1762 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1763 fa6e0e48 2019-05-23 stsp .Pp
1764 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1765 fa6e0e48 2019-05-23 stsp .Pp
1766 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1767 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1768 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1769 fa6e0e48 2019-05-23 stsp .Pp
1770 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1771 5b666081 2020-02-24 stsp .Pp
1772 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
1773 5b666081 2020-02-24 stsp .Pp
1774 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
1775 5b666081 2020-02-24 stsp .Pp
1776 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
1777 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
1778 5b666081 2020-02-24 stsp .Pa sys/uvm :
1779 fa6e0e48 2019-05-23 stsp .Pp
1780 5b666081 2020-02-24 stsp .Dl $ cd sys/uvm && got log '.'
1781 5b666081 2020-02-24 stsp .Pp
1782 5b666081 2020-02-24 stsp And this command has the same effect:
1783 5b666081 2020-02-24 stsp .Pp
1784 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
1785 5b666081 2020-02-24 stsp .Pp
1786 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1787 e70c17ce 2019-05-22 stsp .Pp
1788 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1789 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1790 e70c17ce 2019-05-22 stsp .Pp
1791 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1792 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1793 e70c17ce 2019-05-22 stsp .Pp
1794 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1795 95fc3404 2019-07-15 stsp .Pp
1796 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1797 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1798 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1799 95fc3404 2019-07-15 stsp .Pp
1800 95fc3404 2019-07-15 stsp .Dl $ got update
1801 ac90e726 2019-07-15 stsp .Pp
1802 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1803 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1804 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1805 e70c17ce 2019-05-22 stsp .Pp
1806 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1807 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1808 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1809 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1810 ac90e726 2019-07-15 stsp .Pp
1811 469dd726 2020-03-20 stsp Fetch new upstream commits into the local repository's
1812 469dd726 2020-03-20 stsp .Dq origin/master
1813 469dd726 2020-03-20 stsp branch:
1814 fa6e0e48 2019-05-23 stsp .Pp
1815 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1816 469dd726 2020-03-20 stsp .Dl $ got fetch
1817 469dd726 2020-03-20 stsp .Pp
1818 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
1819 469dd726 2020-03-20 stsp .Cm git clone --bare
1820 469dd726 2020-03-20 stsp the
1821 469dd726 2020-03-20 stsp .Xr git-fetch 1
1822 469dd726 2020-03-20 stsp command must be used instead:
1823 469dd726 2020-03-20 stsp .Pp
1824 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1825 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
1826 fa6e0e48 2019-05-23 stsp .Pp
1827 469dd726 2020-03-20 stsp Rebase the local
1828 469dd726 2020-03-20 stsp .Dq master
1829 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
1830 469dd726 2020-03-20 stsp .Dq origin/master
1831 469dd726 2020-03-20 stsp branch:
1832 469dd726 2020-03-20 stsp .Pp
1833 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1834 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
1835 469dd726 2020-03-20 stsp .Dl $ got rebase master
1836 469dd726 2020-03-20 stsp .Pp
1837 fa6e0e48 2019-05-23 stsp Rebase the
1838 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1839 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1840 fa6e0e48 2019-05-23 stsp .Dq master
1841 fa6e0e48 2019-05-23 stsp branch.
1842 fa6e0e48 2019-05-23 stsp .Pp
1843 818c7501 2019-07-11 stsp .Dl $ got update -b master
1844 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1845 7d7ffedb 2019-07-14 stsp .Pp
1846 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1847 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1848 1dd86744 2019-08-12 anthony .Ox Ns 's
1849 1dd86744 2019-08-12 anthony CVS tree:
1850 7d7ffedb 2019-07-14 stsp .Pp
1851 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1852 7d7ffedb 2019-07-14 stsp .Pp
1853 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1854 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1855 0ebf8283 2019-07-24 stsp branch:
1856 0ebf8283 2019-07-24 stsp .Pp
1857 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1858 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1859 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1860 bf390dec 2020-03-20 stsp .Pp
1861 bf390dec 2020-03-20 stsp In order to merge changes committed to the
1862 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1863 bf390dec 2020-03-20 stsp branch back into the
1864 bf390dec 2020-03-20 stsp .Dq master
1865 bf390dec 2020-03-20 stsp branch, the
1866 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1867 bf390dec 2020-03-20 stsp branch must first be rebased onto the
1868 bf390dec 2020-03-20 stsp .Dq master
1869 bf390dec 2020-03-20 stsp branch:
1870 bf390dec 2020-03-20 stsp .Pp
1871 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1872 bf390dec 2020-03-20 stsp .Dl $ got rebase unified-buffer-cache
1873 bf390dec 2020-03-20 stsp .Pp
1874 bf390dec 2020-03-20 stsp Changes on the
1875 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1876 bf390dec 2020-03-20 stsp branch can now be made visible on the
1877 bf390dec 2020-03-20 stsp .Dq master
1878 bf390dec 2020-03-20 stsp branch with
1879 bf390dec 2020-03-20 stsp .Cm got integrate .
1880 bf390dec 2020-03-20 stsp Because the rebase operation switched the work tree to the
1881 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1882 bf390dec 2020-03-20 stsp branch, the work tree must be switched back to the
1883 bf390dec 2020-03-20 stsp .Dq master
1884 bf390dec 2020-03-20 stsp branch before the
1885 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1886 bf390dec 2020-03-20 stsp branch can be integrated into
1887 bf390dec 2020-03-20 stsp .Dq master :
1888 ff2cf171 2019-07-28 stsp .Pp
1889 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1890 bf390dec 2020-03-20 stsp .Dl $ got integrate unified-buffer-cache
1891 469dd726 2020-03-20 stsp .Pp
1892 469dd726 2020-03-20 stsp Additional steps may be necessary if local changes need to be pushed back
1893 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1894 7b3fde24 2019-07-28 stsp .Cm git push .
1895 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1896 469dd726 2020-03-20 stsp .Cm git clone --bare
1897 7848a0e1 2020-03-19 stsp instead of
1898 7848a0e1 2020-03-19 stsp .Cm got clone ,
1899 ff2cf171 2019-07-28 stsp a Git
1900 ff2cf171 2019-07-28 stsp .Dq refspec
1901 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1902 ff2cf171 2019-07-28 stsp into the
1903 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1904 ff2cf171 2019-07-28 stsp namespace of the local repository.
1905 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1906 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1907 ff2cf171 2019-07-28 stsp configuration variable to the value
1908 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1909 ff2cf171 2019-07-28 stsp with the
1910 ff2cf171 2019-07-28 stsp .Cm git config
1911 ff2cf171 2019-07-28 stsp command:
1912 ff2cf171 2019-07-28 stsp .Pp
1913 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1914 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1915 469dd726 2020-03-20 stsp Additionally, the
1916 469dd726 2020-03-20 stsp .Dq mirror
1917 469dd726 2020-03-20 stsp option must be disabled:
1918 ff2cf171 2019-07-28 stsp .Pp
1919 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
1920 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
1921 469dd726 2020-03-20 stsp .Pp
1922 ff2cf171 2019-07-28 stsp Alternatively, the following
1923 469dd726 2020-03-20 stsp .Xr git-fetch 1
1924 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1925 ff2cf171 2019-07-28 stsp .Pa config
1926 ff2cf171 2019-07-28 stsp file:
1927 0ebf8283 2019-07-24 stsp .Pp
1928 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1929 ff2cf171 2019-07-28 stsp .Dl url = ...
1930 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1931 469dd726 2020-03-20 stsp .Dl mirror = false
1932 ff2cf171 2019-07-28 stsp .Pp
1933 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1934 ff2cf171 2019-07-28 stsp .Dq refs/heads
1935 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1936 ff2cf171 2019-07-28 stsp .Cm got checkout
1937 ff2cf171 2019-07-28 stsp and, if needed, created with
1938 ff2cf171 2019-07-28 stsp .Cm got branch .
1939 ff2cf171 2019-07-28 stsp .Pp
1940 ff2cf171 2019-07-28 stsp Branches in the
1941 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1942 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
1943 ff2cf171 2019-07-28 stsp repository with
1944 469dd726 2020-03-20 stsp .Cm got fetch
1945 469dd726 2020-03-20 stsp or
1946 469dd726 2020-03-20 stsp .Xr git-fetch 1
1947 469dd726 2020-03-20 stsp without extra command line arguments:
1948 ff2cf171 2019-07-28 stsp .Pp
1949 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1950 469dd726 2020-03-20 stsp .Dl $ git fetch
1951 ff2cf171 2019-07-28 stsp .Pp
1952 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
1953 ff2cf171 2019-07-28 stsp .Dq master
1954 7b0db533 2020-02-04 stsp branch, the
1955 ff2cf171 2019-07-28 stsp .Dq master
1956 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1957 ff2cf171 2019-07-28 stsp .Dq origin/master
1958 7b0db533 2020-02-04 stsp branch.
1959 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
1960 ff2cf171 2019-07-28 stsp .Pp
1961 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1962 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1963 083957f4 2020-02-24 stsp .Pp
1964 083957f4 2020-02-24 stsp On the
1965 083957f4 2020-02-24 stsp .Dq master
1966 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
1967 083957f4 2020-02-24 stsp .Dq OK
1968 083957f4 2020-02-24 stsp by other developers and any other important new information:
1969 ff2cf171 2019-07-28 stsp .Pp
1970 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
1971 083957f4 2020-02-24 stsp .Dl $ got histedit -m
1972 083957f4 2020-02-24 stsp .Pp
1973 7b0db533 2020-02-04 stsp Local changes on the
1974 ff2cf171 2019-07-28 stsp .Dq master
1975 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1976 ff2cf171 2019-07-28 stsp repository with
1977 ff2cf171 2019-07-28 stsp .Cm git push :
1978 ff2cf171 2019-07-28 stsp .Pp
1979 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1980 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1981 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1982 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1983 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1984 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1985 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1986 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1987 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1988 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1989 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
1990 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1991 fa6e0e48 2019-05-23 stsp .Nm
1992 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1993 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1994 fa6e0e48 2019-05-23 stsp .Xr git 1
1995 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1996 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.