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