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 0a58e722 2022-10-04 thomas .Op Fl hV
26 5c860e29 2018-03-12 stsp .Ar command
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 1795b260 2021-04-02 kn .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 e8aa341a 2021-10-08 thomas .Tg im
66 56c96eff 2022-08-30 thomas .It Xo
67 56c96eff 2022-08-30 thomas .Cm import
68 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
69 56c96eff 2022-08-30 thomas .Op Fl I Ar pattern
70 56c96eff 2022-08-30 thomas .Op Fl m Ar message
71 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
72 56c96eff 2022-08-30 thomas .Ar directory
73 56c96eff 2022-08-30 thomas .Xc
74 d912d125 2021-11-04 thomas .Dl Pq alias: Cm im
75 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
76 3ce1b845 2019-07-15 stsp within the specified
77 3ce1b845 2019-07-15 stsp .Ar directory .
78 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
79 3ce1b845 2019-07-15 stsp root commit.
80 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
81 3ce1b845 2019-07-15 stsp created commit.
82 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
83 3ce1b845 2019-07-15 stsp .Pp
84 21a44f98 2019-07-15 stsp The
85 21a44f98 2019-07-15 stsp .Cm got import
86 21a44f98 2019-07-15 stsp command requires the
87 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
88 aba9c984 2019-09-08 stsp environment variable to be set,
89 257add31 2020-09-09 stsp unless an author has been configured in
90 257add31 2020-09-09 stsp .Xr got.conf 5
91 257add31 2020-09-09 stsp or Git's
92 aba9c984 2019-09-08 stsp .Dv user.name
93 aba9c984 2019-09-08 stsp and
94 709ae9eb 2019-09-08 stsp .Dv user.email
95 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
96 aba9c984 2019-09-08 stsp .Pa .git/config
97 c9956ddf 2019-09-08 stsp file or from Git's global
98 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
99 c9956ddf 2019-09-08 stsp configuration file.
100 3ce1b845 2019-07-15 stsp .Pp
101 3ce1b845 2019-07-15 stsp The options for
102 3ce1b845 2019-07-15 stsp .Cm got import
103 3ce1b845 2019-07-15 stsp are as follows:
104 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
105 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
106 3ce1b845 2019-07-15 stsp Create the specified
107 e9424ba1 2022-09-20 thomas .Ar branch .
108 e9424ba1 2022-09-20 thomas If this option is not specified, a branch corresponding to the repository's
109 e9424ba1 2022-09-20 thomas HEAD reference will be used.
110 e9424ba1 2022-09-20 thomas Use of this option is required if the branch resolved via the repository's
111 e9424ba1 2022-09-20 thomas HEAD reference already exists.
112 d6506a3d 2022-08-16 thomas .It Fl I Ar pattern
113 d6506a3d 2022-08-16 thomas Ignore files or directories with a name which matches the specified
114 d6506a3d 2022-08-16 thomas .Ar pattern .
115 d6506a3d 2022-08-16 thomas This option may be specified multiple times to build a list of ignore patterns.
116 d6506a3d 2022-08-16 thomas The
117 d6506a3d 2022-08-16 thomas .Ar pattern
118 d6506a3d 2022-08-16 thomas follows the globbing rules documented in
119 d6506a3d 2022-08-16 thomas .Xr glob 7 .
120 e012cf94 2023-02-07 thomas Ignore patterns which end with a slash,
121 e012cf94 2023-02-07 thomas .Dq / ,
122 e012cf94 2023-02-07 thomas will only match directories.
123 3ce1b845 2019-07-15 stsp .It Fl m Ar message
124 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
125 3ce1b845 2019-07-15 stsp Without the
126 3ce1b845 2019-07-15 stsp .Fl m
127 3ce1b845 2019-07-15 stsp option,
128 3ce1b845 2019-07-15 stsp .Cm got import
129 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
130 bccae03f 2023-07-17 thomas Quitting the editor without saving the file will abort the import operation.
131 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
132 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
133 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
134 3ce1b845 2019-07-15 stsp working directory.
135 3ce1b845 2019-07-15 stsp .El
136 e8aa341a 2021-10-08 thomas .Tg cl
137 56c96eff 2022-08-30 thomas .It Xo
138 56c96eff 2022-08-30 thomas .Cm clone
139 56c96eff 2022-08-30 thomas .Op Fl almqv
140 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
141 56c96eff 2022-08-30 thomas .Op Fl R Ar reference
142 56c96eff 2022-08-30 thomas .Ar repository-URL
143 56c96eff 2022-08-30 thomas .Op Ar directory
144 56c96eff 2022-08-30 thomas .Xc
145 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cl
146 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
147 2ab43947 2020-03-18 stsp .Ar repository-URL
148 2ab43947 2020-03-18 stsp into the specified
149 3493b628 2020-03-20 stsp .Ar directory .
150 2ab43947 2020-03-18 stsp If no
151 3493b628 2020-03-20 stsp .Ar directory
152 4b06140e 2022-03-22 thomas is specified, the directory name will be derived from the name of the
153 2ab43947 2020-03-18 stsp cloned repository.
154 2ab43947 2020-03-18 stsp .Cm got clone
155 2ab43947 2020-03-18 stsp will refuse to run if the
156 3493b628 2020-03-20 stsp .Ar directory
157 2ab43947 2020-03-18 stsp already exists.
158 2ab43947 2020-03-18 stsp .Pp
159 2ab43947 2020-03-18 stsp The
160 2ab43947 2020-03-18 stsp .Ar repository-URL
161 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
162 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
163 619eb6dd 2020-03-20 stsp the server:
164 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
165 2ab43947 2020-03-18 stsp .Pp
166 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
167 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
168 2ab43947 2020-03-18 stsp .It git
169 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
170 2ab43947 2020-03-18 stsp .Xr git-daemon 1
171 2ab43947 2020-03-18 stsp server.
172 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
173 10c073e7 2020-03-20 stsp nor encryption.
174 2ab43947 2020-03-18 stsp .It git+ssh
175 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
176 2ab43947 2020-03-18 stsp .Xr ssh 1
177 2ab43947 2020-03-18 stsp tunnel.
178 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
179 2ab43947 2020-03-18 stsp .Xr ssh 1
180 2ab43947 2020-03-18 stsp to use:
181 2ab43947 2020-03-18 stsp .Mt user@hostname
182 2ab43947 2020-03-18 stsp .It ssh
183 2ab43947 2020-03-18 stsp Short alias for git+ssh.
184 cda0eee6 2024-04-25 thomas.ad .It http
185 cda0eee6 2024-04-25 thomas.ad The
186 cda0eee6 2024-04-25 thomas.ad .Dq smart
187 cda0eee6 2024-04-25 thomas.ad HTTP Git protocol.
188 cda0eee6 2024-04-25 thomas.ad Supported by
189 cda0eee6 2024-04-25 thomas.ad .Cm got clone
190 cda0eee6 2024-04-25 thomas.ad and
191 cda0eee6 2024-04-25 thomas.ad .Cm got fetch ,
192 cda0eee6 2024-04-25 thomas.ad but not by
193 cda0eee6 2024-04-25 thomas.ad .Cm got send .
194 cda0eee6 2024-04-25 thomas.ad Not compatible with Git HTTP servers using the
195 cda0eee6 2024-04-25 thomas.ad .Dq dumb
196 cda0eee6 2024-04-25 thomas.ad protocol.
197 cda0eee6 2024-04-25 thomas.ad Use of this protocol is discouraged since it supports neither authentication
198 cda0eee6 2024-04-25 thomas.ad nor encryption.
199 cda0eee6 2024-04-25 thomas.ad .It https
200 cda0eee6 2024-04-25 thomas.ad The
201 cda0eee6 2024-04-25 thomas.ad .Dq smart
202 cda0eee6 2024-04-25 thomas.ad Git HTTP protocol wrapped in SSL/TLS.
203 2ab43947 2020-03-18 stsp .El
204 89c3c67b 2020-03-20 stsp .Pp
205 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
206 89c3c67b 2020-03-20 stsp from the server.
207 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
208 89c3c67b 2020-03-20 stsp within.
209 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
210 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
211 89c3c67b 2020-03-20 stsp This can take some time.
212 010f7279 2020-03-20 stsp More details about the pack file format are documented in
213 010f7279 2020-03-20 stsp .Xr git-repository 5 .
214 2ab43947 2020-03-18 stsp .Pp
215 7848a0e1 2020-03-19 stsp .Cm got clone
216 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
217 257add31 2020-09-09 stsp .Xr got.conf 5
218 257add31 2020-09-09 stsp and
219 7848a0e1 2020-03-19 stsp .Pa config
220 257add31 2020-09-09 stsp files of the cloned repository to store the
221 7848a0e1 2020-03-19 stsp .Ar repository-url
222 99495ddb 2021-01-10 stsp and any
223 15d3c221 2021-01-05 stsp .Ar branch
224 99495ddb 2021-01-10 stsp or
225 99495ddb 2021-01-10 stsp .Ar reference
226 132af4a5 2021-01-05 stsp arguments for future use by
227 7848a0e1 2020-03-19 stsp .Cm got fetch
228 fc24bb3a 2020-03-21 stsp or
229 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
230 7848a0e1 2020-03-19 stsp .Pp
231 2ab43947 2020-03-18 stsp The options for
232 2ab43947 2020-03-18 stsp .Cm got clone
233 2ab43947 2020-03-18 stsp are as follows:
234 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
235 659e7fbd 2020-03-20 stsp .It Fl a
236 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
237 1d4b192f 2020-03-21 stsp .Dq refs/heads/
238 5aa20203 2021-01-05 stsp reference namespace and set
239 25eb5847 2022-07-03 thomas .Cm fetch_all_branches
240 5aa20203 2021-01-05 stsp in the cloned repository's
241 5aa20203 2021-01-05 stsp .Xr got.conf 5
242 5aa20203 2021-01-05 stsp file for future use by
243 5aa20203 2021-01-05 stsp .Cm got fetch .
244 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
245 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
246 4ba14133 2020-03-20 stsp Cannot be used together with the
247 4ba14133 2020-03-20 stsp .Fl b
248 4ba14133 2020-03-20 stsp option.
249 4ba14133 2020-03-20 stsp .It Fl b Ar branch
250 4ba14133 2020-03-20 stsp Fetch the specified
251 4ba14133 2020-03-20 stsp .Ar branch
252 1d4b192f 2020-03-21 stsp from the remote repository's
253 1d4b192f 2020-03-21 stsp .Dq refs/heads/
254 1d4b192f 2020-03-21 stsp reference namespace.
255 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
256 4ba14133 2020-03-20 stsp to fetch.
257 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
258 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
259 4ba14133 2020-03-20 stsp branch which was fetched.
260 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
261 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
262 4ba14133 2020-03-20 stsp Cannot be used together with the
263 4ba14133 2020-03-20 stsp .Fl a
264 4ba14133 2020-03-20 stsp option.
265 41b0de12 2020-03-21 stsp .It Fl l
266 a18cccf9 2020-03-21 stsp List branches and tags available for fetching from the remote repository
267 41b0de12 2020-03-21 stsp and exit immediately.
268 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
269 a5a46be2 2021-01-27 stsp .Fl q
270 a5a46be2 2021-01-27 stsp and
271 41b0de12 2020-03-21 stsp .Fl v .
272 469dd726 2020-03-20 stsp .It Fl m
273 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
274 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
275 bd81cfb7 2020-04-19 stsp locally created commits.
276 469dd726 2020-03-20 stsp .Pp
277 469dd726 2020-03-20 stsp The repository's
278 257add31 2020-09-09 stsp .Xr got.conf 5
279 257add31 2020-09-09 stsp and
280 469dd726 2020-03-20 stsp .Pa config
281 257add31 2020-09-09 stsp files will be set up with the
282 469dd726 2020-03-20 stsp .Dq mirror
283 469dd726 2020-03-20 stsp option enabled, such that
284 469dd726 2020-03-20 stsp .Cm got fetch
285 469dd726 2020-03-20 stsp or
286 469dd726 2020-03-20 stsp .Xr git-fetch 1
287 bd81cfb7 2020-04-19 stsp will write incoming changes directly to branches in the
288 469dd726 2020-03-20 stsp .Dq refs/heads/
289 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
290 469dd726 2020-03-20 stsp .Dq refs/remotes/
291 469dd726 2020-03-20 stsp namespace.
292 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
293 469dd726 2020-03-20 stsp .Cm got rebase
294 1a70a207 2023-07-05 thomas or
295 1a70a207 2023-07-05 thomas .Cm got merge
296 469dd726 2020-03-20 stsp after
297 469dd726 2020-03-20 stsp .Cm got fetch
298 bd81cfb7 2020-04-19 stsp in order to make incoming changes appear on branches in the
299 bd81cfb7 2020-04-19 stsp .Dq refs/heads/
300 bd81cfb7 2020-04-19 stsp namespace.
301 bd81cfb7 2020-04-19 stsp But maintaining custom changes in the cloned repository becomes difficult
302 bd81cfb7 2020-04-19 stsp since such changes will be at risk of being discarded whenever incoming
303 498ef124 2020-03-21 stsp changes are fetched.
304 2ab43947 2020-03-18 stsp .It Fl q
305 2ab43947 2020-03-18 stsp Suppress progress reporting output.
306 2ab43947 2020-03-18 stsp The same option will be passed to
307 2ab43947 2020-03-18 stsp .Xr ssh 1
308 2ab43947 2020-03-18 stsp if applicable.
309 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
310 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
311 0e4002ca 2020-03-21 stsp .Ar reference
312 0e4002ca 2020-03-21 stsp from the remote repository's
313 0e4002ca 2020-03-21 stsp .Dq refs/
314 0e4002ca 2020-03-21 stsp namespace.
315 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
316 0e4002ca 2020-03-21 stsp references to fetch.
317 71f12362 2020-03-21 stsp The specified
318 71f12362 2020-03-21 stsp .Ar reference
319 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
320 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
321 0e4002ca 2020-03-21 stsp .Pp
322 71f12362 2020-03-21 stsp Each reference will be mapped into the cloned repository's
323 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
324 0e4002ca 2020-03-21 stsp namespace, unless the
325 0e4002ca 2020-03-21 stsp .Fl m
326 0e4002ca 2020-03-21 stsp option is used to mirror references directly into the cloned repository's
327 0e4002ca 2020-03-21 stsp .Dq refs/
328 0e4002ca 2020-03-21 stsp namespace.
329 0e4002ca 2020-03-21 stsp .Pp
330 0e4002ca 2020-03-21 stsp .Cm got clone
331 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
332 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
333 0e4002ca 2020-03-21 stsp or
334 0e4002ca 2020-03-21 stsp .Dq refs/got/
335 0e4002ca 2020-03-21 stsp namespace.
336 d6506a3d 2022-08-16 thomas .It Fl v
337 d6506a3d 2022-08-16 thomas Verbose mode.
338 d6506a3d 2022-08-16 thomas Causes
339 d6506a3d 2022-08-16 thomas .Cm got clone
340 d6506a3d 2022-08-16 thomas to print debugging messages to standard error output.
341 d6506a3d 2022-08-16 thomas This option will be passed to
342 d6506a3d 2022-08-16 thomas .Xr ssh 1
343 d6506a3d 2022-08-16 thomas if applicable.
344 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
345 d6506a3d 2022-08-16 thomas The maximum is 3.
346 2ab43947 2020-03-18 stsp .El
347 e8aa341a 2021-10-08 thomas .Tg fe
348 56c96eff 2022-08-30 thomas .It Xo
349 56c96eff 2022-08-30 thomas .Cm fetch
350 56c96eff 2022-08-30 thomas .Op Fl adlqtvX
351 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
352 56c96eff 2022-08-30 thomas .Op Fl R Ar reference
353 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
354 56c96eff 2022-08-30 thomas .Op Ar remote-repository
355 56c96eff 2022-08-30 thomas .Xc
356 d912d125 2021-11-04 thomas .Dl Pq alias: Cm fe
357 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
358 7848a0e1 2020-03-19 stsp If no
359 4ba14133 2020-03-20 stsp .Ar remote-repository
360 4ba14133 2020-03-20 stsp is specified,
361 7848a0e1 2020-03-19 stsp .Dq origin
362 7848a0e1 2020-03-19 stsp will be used.
363 50b0790e 2020-09-11 stsp The remote repository's URL is obtained from the corresponding entry in
364 257add31 2020-09-09 stsp .Xr got.conf 5
365 50b0790e 2020-09-11 stsp or Git's
366 7848a0e1 2020-03-19 stsp .Pa config
367 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
368 7848a0e1 2020-03-19 stsp .Cm got clone .
369 7848a0e1 2020-03-19 stsp .Pp
370 8d0dceb3 2023-02-07 thomas By default, any branches configured in
371 8d0dceb3 2023-02-07 thomas .Xr got.conf 5
372 8d0dceb3 2023-02-07 thomas for the
373 7917d6d5 2023-02-17 thomas .Ar remote-repository
374 8d0dceb3 2023-02-07 thomas will be fetched.
375 8d0dceb3 2023-02-07 thomas If
376 8d0dceb3 2023-02-07 thomas .Cm got fetch
377 8d0dceb3 2023-02-07 thomas is invoked in a work tree then this work tree's current branch will be
378 8d0dceb3 2023-02-07 thomas fetched, too, provided it is present on the server.
379 7917d6d5 2023-02-17 thomas If no branches to fetch can be found in
380 7917d6d5 2023-02-17 thomas .Xr got.conf 5
381 7917d6d5 2023-02-17 thomas or via a work tree, or said branches are not found on the server, a branch
382 7917d6d5 2023-02-17 thomas resolved via the remote repository's HEAD reference will be fetched.
383 7abf1863 2023-02-20 thomas Likewise, if a HEAD reference for the
384 7abf1863 2023-02-20 thomas .Ar remote-repository
385 7abf1863 2023-02-20 thomas exists but its target no longer matches the remote HEAD, then
386 7abf1863 2023-02-20 thomas the new target branch will be fetched.
387 8d0dceb3 2023-02-07 thomas This default behaviour can be overridden with the
388 8d0dceb3 2023-02-07 thomas .Fl a
389 8d0dceb3 2023-02-07 thomas and
390 8d0dceb3 2023-02-07 thomas .Fl b
391 8d0dceb3 2023-02-07 thomas options.
392 8d0dceb3 2023-02-07 thomas .Pp
393 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
394 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
395 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
396 89c3c67b 2020-03-20 stsp .Pp
397 498ef124 2020-03-21 stsp By default, branch references in the
398 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
399 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
400 498ef124 2020-03-21 stsp The
401 498ef124 2020-03-21 stsp .Cm got rebase
402 1a70a207 2023-07-05 thomas or
403 1a70a207 2023-07-05 thomas .Cm got merge
404 bd81cfb7 2020-04-19 stsp command can then be used to make new changes visible on branches in the
405 7848a0e1 2020-03-19 stsp .Dq refs/heads/
406 bd81cfb7 2020-04-19 stsp namespace, merging incoming changes with the changes on those branches
407 bd81cfb7 2020-04-19 stsp as necessary.
408 7848a0e1 2020-03-19 stsp .Pp
409 498ef124 2020-03-21 stsp If the repository was created as a mirror with
410 4b06140e 2022-03-22 thomas .Cm got clone -m ,
411 498ef124 2020-03-21 stsp then all branches in the
412 469dd726 2020-03-20 stsp .Dq refs/heads/
413 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
414 498ef124 2020-03-21 stsp the remote repository.
415 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
416 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
417 e6786710 2021-07-03 stsp by Git's garbage collector or
418 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
419 bd81cfb7 2020-04-19 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
420 469dd726 2020-03-20 stsp .Pp
421 db6d8ad8 2020-03-21 stsp In any case, references in the
422 7848a0e1 2020-03-19 stsp .Dq refs/tags/
423 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
424 db6d8ad8 2020-03-21 stsp in the same namespace.
425 7848a0e1 2020-03-19 stsp .Pp
426 7848a0e1 2020-03-19 stsp The options for
427 7848a0e1 2020-03-19 stsp .Cm got fetch
428 7848a0e1 2020-03-19 stsp are as follows:
429 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
430 659e7fbd 2020-03-20 stsp .It Fl a
431 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
432 1d4b192f 2020-03-21 stsp .Dq refs/heads/
433 1d4b192f 2020-03-21 stsp reference namespace.
434 0c8b29c5 2021-01-05 stsp This option can be enabled by default for specific repositories in
435 0c8b29c5 2021-01-05 stsp .Xr got.conf 5 .
436 4ba14133 2020-03-20 stsp Cannot be used together with the
437 4ba14133 2020-03-20 stsp .Fl b
438 4ba14133 2020-03-20 stsp option.
439 4ba14133 2020-03-20 stsp .It Fl b Ar branch
440 4ba14133 2020-03-20 stsp Fetch the specified
441 4ba14133 2020-03-20 stsp .Ar branch
442 1d4b192f 2020-03-21 stsp from the remote repository's
443 1d4b192f 2020-03-21 stsp .Dq refs/heads/
444 1d4b192f 2020-03-21 stsp reference namespace.
445 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
446 4ba14133 2020-03-20 stsp to fetch.
447 4ba14133 2020-03-20 stsp Cannot be used together with the
448 4ba14133 2020-03-20 stsp .Fl a
449 4ba14133 2020-03-20 stsp option.
450 f21ec2f0 2020-03-21 stsp .It Fl d
451 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
452 f21ec2f0 2020-03-21 stsp present in the remote repository.
453 f21ec2f0 2020-03-21 stsp Only references are deleted.
454 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
455 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
456 e6786710 2021-07-03 stsp Git's garbage collector or
457 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
458 41b0de12 2020-03-21 stsp .It Fl l
459 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
460 41b0de12 2020-03-21 stsp and exit immediately.
461 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
462 612392ee 2021-01-05 stsp .Fl v ,
463 612392ee 2021-01-05 stsp .Fl q ,
464 41b0de12 2020-03-21 stsp and
465 41b0de12 2020-03-21 stsp .Fl r .
466 7848a0e1 2020-03-19 stsp .It Fl q
467 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
468 7848a0e1 2020-03-19 stsp The same option will be passed to
469 7848a0e1 2020-03-19 stsp .Xr ssh 1
470 7848a0e1 2020-03-19 stsp if applicable.
471 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
472 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
473 0e4002ca 2020-03-21 stsp .Ar reference
474 0e4002ca 2020-03-21 stsp from the remote repository's
475 0e4002ca 2020-03-21 stsp .Dq refs/
476 0e4002ca 2020-03-21 stsp namespace.
477 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
478 0e4002ca 2020-03-21 stsp references to fetch.
479 71f12362 2020-03-21 stsp The specified
480 71f12362 2020-03-21 stsp .Ar reference
481 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
482 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
483 0e4002ca 2020-03-21 stsp .Pp
484 0e4002ca 2020-03-21 stsp Each reference will be mapped into the local repository's
485 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
486 0e4002ca 2020-03-21 stsp namespace, unless the local repository was created as a mirror with
487 a18cccf9 2020-03-21 stsp .Cm got clone -m
488 a18cccf9 2020-03-21 stsp in which case references will be mapped directly into the local repository's
489 a18cccf9 2020-03-21 stsp .Dq refs/
490 a18cccf9 2020-03-21 stsp namespace.
491 a18cccf9 2020-03-21 stsp .Pp
492 bd81cfb7 2020-04-19 stsp Once a reference has been fetched, a branch based on it can be created with
493 0e4002ca 2020-03-21 stsp .Cm got branch
494 0e4002ca 2020-03-21 stsp if needed.
495 0e4002ca 2020-03-21 stsp .Pp
496 0e4002ca 2020-03-21 stsp .Cm got fetch
497 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
498 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
499 0e4002ca 2020-03-21 stsp or
500 0e4002ca 2020-03-21 stsp .Dq refs/got/
501 0e4002ca 2020-03-21 stsp namespace.
502 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
503 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
504 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
505 d6506a3d 2022-08-16 thomas working directory.
506 d6506a3d 2022-08-16 thomas If this directory is a
507 d6506a3d 2022-08-16 thomas .Nm
508 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
509 d6506a3d 2022-08-16 thomas .It Fl t
510 d6506a3d 2022-08-16 thomas Allow existing references in the
511 d6506a3d 2022-08-16 thomas .Dq refs/tags
512 d6506a3d 2022-08-16 thomas namespace to be updated if they have changed on the server.
513 d6506a3d 2022-08-16 thomas If not specified, only new tag references will be created.
514 d6506a3d 2022-08-16 thomas .It Fl v
515 d6506a3d 2022-08-16 thomas Verbose mode.
516 d6506a3d 2022-08-16 thomas Causes
517 d6506a3d 2022-08-16 thomas .Cm got fetch
518 d6506a3d 2022-08-16 thomas to print debugging messages to standard error output.
519 d6506a3d 2022-08-16 thomas The same option will be passed to
520 d6506a3d 2022-08-16 thomas .Xr ssh 1
521 d6506a3d 2022-08-16 thomas if applicable.
522 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
523 d6506a3d 2022-08-16 thomas The maximum is 3.
524 161728eb 2021-07-24 stsp .It Fl X
525 161728eb 2021-07-24 stsp Delete all references which correspond to a particular
526 161728eb 2021-07-24 stsp .Ar remote-repository
527 161728eb 2021-07-24 stsp instead of fetching new changes.
528 161728eb 2021-07-24 stsp This can be useful when a remote repository is being removed from
529 161728eb 2021-07-24 stsp .Xr got.conf 5 .
530 161728eb 2021-07-24 stsp .Pp
531 161728eb 2021-07-24 stsp With
532 161728eb 2021-07-24 stsp .Fl X ,
533 161728eb 2021-07-24 stsp the
534 161728eb 2021-07-24 stsp .Ar remote-repository
535 161728eb 2021-07-24 stsp argument is mandatory and no other options except
536 161728eb 2021-07-24 stsp .Fl r ,
537 161728eb 2021-07-24 stsp .Fl v ,
538 161728eb 2021-07-24 stsp and
539 161728eb 2021-07-24 stsp .Fl q
540 161728eb 2021-07-24 stsp are allowed.
541 161728eb 2021-07-24 stsp .Pp
542 161728eb 2021-07-24 stsp Only references are deleted.
543 161728eb 2021-07-24 stsp Any commit, tree, tag, and blob objects fetched from a remote repository
544 161728eb 2021-07-24 stsp will generally be stored in pack files and may be removed separately with
545 161728eb 2021-07-24 stsp .Xr git-repack 1
546 161728eb 2021-07-24 stsp and Git's garbage collector.
547 7848a0e1 2020-03-19 stsp .El
548 e8aa341a 2021-10-08 thomas .Tg co
549 56c96eff 2022-08-30 thomas .It Xo
550 56c96eff 2022-08-30 thomas .Cm checkout
551 233dfb11 2024-04-09 thomas .Op Fl \&Eq
552 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
553 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
554 56c96eff 2022-08-30 thomas .Op Fl p Ar path-prefix
555 56c96eff 2022-08-30 thomas .Ar repository-path
556 56c96eff 2022-08-30 thomas .Op Ar work-tree-path
557 56c96eff 2022-08-30 thomas .Xc
558 d912d125 2021-11-04 thomas .Dl Pq alias: Cm co
559 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
560 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
561 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
562 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
563 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
564 bb51a5b4 2020-01-13 stsp .El
565 bb51a5b4 2020-01-13 stsp .Pp
566 5d7c1dab 2018-04-01 stsp If the
567 5d7c1dab 2018-04-01 stsp .Ar work tree path
568 c844a238 2019-02-06 stsp is not specified, either use the last component of
569 5d7c1dab 2018-04-01 stsp .Ar repository path ,
570 5d7c1dab 2018-04-01 stsp or if a
571 5d7c1dab 2018-04-01 stsp .Ar path prefix
572 c844a238 2019-02-06 stsp was specified use the last component of
573 5d7c1dab 2018-04-01 stsp .Ar path prefix .
574 38e11793 2018-06-13 stsp .Pp
575 38e11793 2018-06-13 stsp The options for
576 38e11793 2018-06-13 stsp .Cm got checkout
577 38e11793 2018-06-13 stsp are as follows:
578 38e11793 2018-06-13 stsp .Bl -tag -width Ds
579 08573d5b 2019-05-14 stsp .It Fl b Ar branch
580 3c575567 2019-07-28 stsp Check out files from a commit on the specified
581 08573d5b 2019-05-14 stsp .Ar branch .
582 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
583 08573d5b 2019-05-14 stsp reference will be used.
584 8069f636 2019-01-12 stsp .It Fl c Ar commit
585 8069f636 2019-01-12 stsp Check out files from the specified
586 3c575567 2019-07-28 stsp .Ar commit
587 3c575567 2019-07-28 stsp on the selected branch.
588 482b0b83 2023-07-19 thomas If this option is not specified, the most recent commit on the selected
589 482b0b83 2023-07-19 thomas branch will be used.
590 482b0b83 2023-07-19 thomas .Pp
591 482b0b83 2023-07-19 thomas The expected
592 482b0b83 2023-07-19 thomas .Ar commit
593 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
594 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
595 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
596 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
597 a290e4b4 2023-07-19 thomas The keywords
598 fb885120 2023-07-19 thomas .Qq :base
599 fb885120 2023-07-19 thomas and
600 fb885120 2023-07-19 thomas .Qq :head
601 a290e4b4 2023-07-19 thomas resolve to the repository's HEAD reference, or, if the
602 fb885120 2023-07-19 thomas .Fl b
603 fb885120 2023-07-19 thomas option is used, the head of the checked-out
604 fb885120 2023-07-19 thomas .Ar branch .
605 fb885120 2023-07-19 thomas Keywords and reference names may be appended with
606 fb885120 2023-07-19 thomas .Qq :+
607 fb885120 2023-07-19 thomas or
608 fb885120 2023-07-19 thomas .Qq :-
609 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
610 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
611 fb885120 2023-07-19 thomas for example,
612 fb885120 2023-07-19 thomas .Sy :head:-2
613 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
614 fb885120 2023-07-19 thomas .Sy foo:-3
615 fb885120 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
616 fb885120 2023-07-19 thomas .Qq foo
617 fb885120 2023-07-19 thomas reference.
618 fb885120 2023-07-19 thomas If an integer does not follow the
619 fb885120 2023-07-19 thomas .Qq :+
620 fb885120 2023-07-19 thomas or
621 fb885120 2023-07-19 thomas .Qq :-
622 fb885120 2023-07-19 thomas modifier, a
623 fb885120 2023-07-19 thomas .Qq 1
624 fb885120 2023-07-19 thomas is implicitly appended
625 fb885120 2023-07-19 thomas .Po e.g.,
626 fb885120 2023-07-19 thomas .Sy :head:-
627 fb885120 2023-07-19 thomas is equivalent to
628 fb885120 2023-07-19 thomas .Sy :head:-1
629 fb885120 2023-07-19 thomas .Pc .
630 4b6c9460 2020-03-05 stsp .Pp
631 4b6c9460 2020-03-05 stsp If the specified
632 4b6c9460 2020-03-05 stsp .Ar commit
633 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
634 4b6c9460 2020-03-05 stsp this commit must be specified with the
635 4b6c9460 2020-03-05 stsp .Fl b
636 4b6c9460 2020-03-05 stsp option.
637 4b06140e 2022-03-22 thomas If no such branch is known, a new branch must be created for this
638 4b6c9460 2020-03-05 stsp commit with
639 4b6c9460 2020-03-05 stsp .Cm got branch
640 4b6c9460 2020-03-05 stsp before
641 4b6c9460 2020-03-05 stsp .Cm got checkout
642 4b6c9460 2020-03-05 stsp can be used.
643 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
644 d6506a3d 2022-08-16 thomas .It Fl E
645 d6506a3d 2022-08-16 thomas Proceed with the checkout operation even if the directory at
646 d6506a3d 2022-08-16 thomas .Ar work-tree-path
647 d6506a3d 2022-08-16 thomas is not empty.
648 d6506a3d 2022-08-16 thomas Existing files will be left intact.
649 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
650 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
651 38e11793 2018-06-13 stsp Only files beneath the specified
652 38e11793 2018-06-13 stsp .Ar path-prefix
653 38e11793 2018-06-13 stsp will be checked out.
654 4ad4a1ec 2021-09-13 tracey .It Fl q
655 4ad4a1ec 2021-09-13 tracey Silence progress output.
656 38e11793 2018-06-13 stsp .El
657 e8aa341a 2021-10-08 thomas .Tg up
658 56c96eff 2022-08-30 thomas .It Xo
659 56c96eff 2022-08-30 thomas .Cm update
660 56c96eff 2022-08-30 thomas .Op Fl q
661 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
662 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
663 56c96eff 2022-08-30 thomas .Op Ar path ...
664 56c96eff 2022-08-30 thomas .Xc
665 d912d125 2021-11-04 thomas .Dl Pq alias: Cm up
666 4f331d3a 2020-04-01 stsp Update an existing work tree to a different
667 4f331d3a 2020-04-01 stsp .Ar commit .
668 4f331d3a 2020-04-01 stsp Change existing files in the work tree as necessary to match file contents
669 4f331d3a 2020-04-01 stsp of this commit.
670 4f331d3a 2020-04-01 stsp Preserve any local changes in the work tree and merge them with the
671 4f331d3a 2020-04-01 stsp incoming changes.
672 4f331d3a 2020-04-01 stsp .Pp
673 5036ab18 2020-04-18 stsp Files which already contain merge conflicts will not be updated to avoid
674 5036ab18 2020-04-18 stsp further complications.
675 5036ab18 2020-04-18 stsp Such files will be updated when
676 5036ab18 2020-04-18 stsp .Cm got update
677 5036ab18 2020-04-18 stsp is run again after merge conflicts have been resolved.
678 4b06140e 2022-03-22 thomas If the conflicting changes are no longer needed, affected files can be
679 5036ab18 2020-04-18 stsp reverted with
680 5036ab18 2020-04-18 stsp .Cm got revert
681 5036ab18 2020-04-18 stsp before running
682 5036ab18 2020-04-18 stsp .Cm got update
683 5036ab18 2020-04-18 stsp again.
684 5036ab18 2020-04-18 stsp .Pp
685 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
686 7f838b36 2019-02-08 stsp .Bl -column YXZ description
687 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
688 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
689 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
690 7f838b36 2019-02-08 stsp .It D Ta file was deleted
691 9f323212 2023-03-10 thomas .It d Ta file's deletion was prevented by local modifications
692 7f838b36 2019-02-08 stsp .It A Ta new file was added
693 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
694 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
695 5036ab18 2020-04-18 stsp .It # Ta file was not updated because it contains merge conflicts
696 3b9f0f87 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
697 7f838b36 2019-02-08 stsp .El
698 7f838b36 2019-02-08 stsp .Pp
699 f2ea84fa 2019-07-27 stsp If no
700 c4cdcb68 2019-04-03 stsp .Ar path
701 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
702 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
703 f2ea84fa 2019-07-27 stsp specified paths.
704 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
705 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
706 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
707 f2cf8fbb 2019-04-04 stsp Some
708 f2cf8fbb 2019-04-04 stsp .Nm
709 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
710 c4cdcb68 2019-04-03 stsp multiple base commits.
711 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
712 47ec7be7 2019-05-12 stsp .Cm got update
713 47ec7be7 2019-05-12 stsp across the entire work tree.
714 024e9686 2019-05-14 stsp Specifying a
715 024e9686 2019-05-14 stsp .Ar path
716 024e9686 2019-05-14 stsp is incompatible with the
717 024e9686 2019-05-14 stsp .Fl b
718 024e9686 2019-05-14 stsp option.
719 7f838b36 2019-02-08 stsp .Pp
720 4ed9f614 2019-08-04 stsp .Cm got update
721 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
722 4ed9f614 2019-08-04 stsp If changes have been staged with
723 4ed9f614 2019-08-04 stsp .Cm got stage ,
724 bc3056e3 2019-08-18 stsp these changes must first be committed with
725 4ed9f614 2019-08-04 stsp .Cm got commit
726 4ed9f614 2019-08-04 stsp or unstaged with
727 4ed9f614 2019-08-04 stsp .Cm got unstage .
728 4ed9f614 2019-08-04 stsp .Pp
729 507dc3bb 2018-12-29 stsp The options for
730 507dc3bb 2018-12-29 stsp .Cm got update
731 507dc3bb 2018-12-29 stsp are as follows:
732 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
733 024e9686 2019-05-14 stsp .It Fl b Ar branch
734 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
735 024e9686 2019-05-14 stsp .Ar branch
736 024e9686 2019-05-14 stsp before updating the work tree.
737 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
738 4f331d3a 2020-04-01 stsp .Pp
739 4f331d3a 2020-04-01 stsp As usual, any local changes in the work tree will be preserved.
740 4f331d3a 2020-04-01 stsp This can be useful when switching to a newly created branch in order
741 4f331d3a 2020-04-01 stsp to commit existing local changes to this branch.
742 4f331d3a 2020-04-01 stsp .Pp
743 4f331d3a 2020-04-01 stsp Any local changes must be dealt with separately in order to obtain a
744 4f331d3a 2020-04-01 stsp work tree with pristine file contents corresponding exactly to the specified
745 4f331d3a 2020-04-01 stsp .Ar branch .
746 4f331d3a 2020-04-01 stsp Such changes could first be committed to a different branch with
747 4f331d3a 2020-04-01 stsp .Cm got commit ,
748 4f331d3a 2020-04-01 stsp or could be discarded with
749 4f331d3a 2020-04-01 stsp .Cm got revert .
750 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
751 507dc3bb 2018-12-29 stsp Update the work tree to the specified
752 507dc3bb 2018-12-29 stsp .Ar commit .
753 482b0b83 2023-07-19 thomas If this option is not specified, the most recent commit on the work tree's
754 482b0b83 2023-07-19 thomas branch will be used.
755 482b0b83 2023-07-19 thomas .Pp
756 482b0b83 2023-07-19 thomas The expected
757 482b0b83 2023-07-19 thomas .Ar commit
758 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
759 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
760 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
761 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
762 a290e4b4 2023-07-19 thomas The keywords
763 9139e004 2023-07-17 thomas .Qq :base
764 9139e004 2023-07-17 thomas and
765 9139e004 2023-07-17 thomas .Qq :head
766 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
767 9139e004 2023-07-17 thomas Keywords and reference names may be appended with
768 9139e004 2023-07-17 thomas .Qq :+
769 9139e004 2023-07-17 thomas or
770 9139e004 2023-07-17 thomas .Qq :-
771 9139e004 2023-07-17 thomas modifiers and an optional integer N to denote the
772 9139e004 2023-07-17 thomas Nth descendant or antecedent, respectively, by first parent traversal;
773 9139e004 2023-07-17 thomas for example,
774 9139e004 2023-07-17 thomas .Sy :head:-2
775 1b990074 2023-07-17 thomas denotes the work tree branch head's 2nd generation ancestor, and
776 9139e004 2023-07-17 thomas .Sy :base:+4
777 9139e004 2023-07-17 thomas denotes the 4th generation descendant of the work tree's base commit.
778 9139e004 2023-07-17 thomas Similarly,
779 9139e004 2023-07-17 thomas .Sy foo:-3
780 9139e004 2023-07-17 thomas will denote the 3rd generation ancestor of the commit resolved by the
781 9139e004 2023-07-17 thomas .Qq foo
782 9139e004 2023-07-17 thomas reference.
783 9139e004 2023-07-17 thomas If an integer does not follow the
784 9139e004 2023-07-17 thomas .Qq :+
785 9139e004 2023-07-17 thomas or
786 9139e004 2023-07-17 thomas .Qq :-
787 9139e004 2023-07-17 thomas modifier, a
788 9139e004 2023-07-17 thomas .Qq 1
789 9139e004 2023-07-17 thomas is implicitly appended
790 9139e004 2023-07-17 thomas .Po e.g.,
791 9139e004 2023-07-17 thomas .Sy :head:-
792 9139e004 2023-07-17 thomas is equivalent to
793 9139e004 2023-07-17 thomas .Sy :head:-1
794 9139e004 2023-07-17 thomas .Pc .
795 4ad4a1ec 2021-09-13 tracey .It Fl q
796 4ad4a1ec 2021-09-13 tracey Silence progress output.
797 507dc3bb 2018-12-29 stsp .El
798 e8aa341a 2021-10-08 thomas .Tg st
799 56c96eff 2022-08-30 thomas .It Xo
800 56c96eff 2022-08-30 thomas .Cm status
801 56c96eff 2022-08-30 thomas .Op Fl I
802 56c96eff 2022-08-30 thomas .Op Fl S Ar status-codes
803 56c96eff 2022-08-30 thomas .Op Fl s Ar status-codes
804 56c96eff 2022-08-30 thomas .Op Ar path ...
805 56c96eff 2022-08-30 thomas .Xc
806 d912d125 2021-11-04 thomas .Dl Pq alias: Cm st
807 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
808 6bad629b 2019-02-04 stsp using the following status codes:
809 6bad629b 2019-02-04 stsp .Bl -column YXZ description
810 6bad629b 2019-02-04 stsp .It M Ta modified file
811 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
812 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
813 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
814 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
815 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
816 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
817 6bad629b 2019-02-04 stsp .Nm
818 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
819 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
820 2a06fe5f 2019-08-24 stsp .Ar path
821 2a06fe5f 2019-08-24 stsp specified on the command line
822 6bad629b 2019-02-04 stsp .El
823 6bad629b 2019-02-04 stsp .Pp
824 72ea6654 2019-07-27 stsp If no
825 927df6b7 2019-02-10 stsp .Ar path
826 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
827 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
828 4ed9f614 2019-08-04 stsp .Pp
829 4ed9f614 2019-08-04 stsp If changes have been staged with
830 4ed9f614 2019-08-04 stsp .Cm got stage ,
831 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
832 4ed9f614 2019-08-04 stsp status codes:
833 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
834 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
835 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
836 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
837 4ed9f614 2019-08-04 stsp .El
838 4ed9f614 2019-08-04 stsp .Pp
839 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
840 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
841 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
842 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
843 4ed9f614 2019-08-04 stsp .El
844 cd634f2d 2024-03-30 thomas .Pp
845 cd634f2d 2024-03-30 thomas If the work tree contains the results of an interrupted
846 cd634f2d 2024-03-30 thomas .Cm got rebase ,
847 e2e46a52 2024-03-30 thomas .Cm got histedit ,
848 e2e46a52 2024-03-30 thomas or
849 cd634f2d 2024-03-30 thomas .Cm got merge
850 cd634f2d 2024-03-30 thomas operation then display a message which shows the branches involved.
851 6841da00 2019-08-08 stsp .Pp
852 081470ac 2020-08-13 stsp The options for
853 081470ac 2020-08-13 stsp .Cm got status
854 081470ac 2020-08-13 stsp are as follows:
855 081470ac 2020-08-13 stsp .Bl -tag -width Ds
856 f6343036 2021-06-22 stsp .It Fl I
857 f6343036 2021-06-22 stsp Show unversioned files even if they match an ignore pattern.
858 d6506a3d 2022-08-16 thomas .It Fl S Ar status-codes
859 d6506a3d 2022-08-16 thomas Suppress the output of files with a modification status matching any of the
860 00357e4d 2021-09-14 tracey single-character status codes contained in the
861 00357e4d 2021-09-14 tracey .Ar status-codes
862 00357e4d 2021-09-14 tracey argument.
863 00357e4d 2021-09-14 tracey Any combination of codes from the above list of possible status codes
864 00357e4d 2021-09-14 tracey may be specified.
865 00357e4d 2021-09-14 tracey For staged files, status codes displayed in either column will be matched.
866 b043307b 2021-09-14 stsp Cannot be used together with the
867 d6506a3d 2022-08-16 thomas .Fl s
868 b043307b 2021-09-14 stsp option.
869 d6506a3d 2022-08-16 thomas .It Fl s Ar status-codes
870 d6506a3d 2022-08-16 thomas Only show files with a modification status matching any of the
871 081470ac 2020-08-13 stsp single-character status codes contained in the
872 081470ac 2020-08-13 stsp .Ar status-codes
873 081470ac 2020-08-13 stsp argument.
874 081470ac 2020-08-13 stsp Any combination of codes from the above list of possible status codes
875 081470ac 2020-08-13 stsp may be specified.
876 081470ac 2020-08-13 stsp For staged files, status codes displayed in either column will be matched.
877 b043307b 2021-09-14 stsp Cannot be used together with the
878 d6506a3d 2022-08-16 thomas .Fl S
879 b043307b 2021-09-14 stsp option.
880 081470ac 2020-08-13 stsp .El
881 081470ac 2020-08-13 stsp .Pp
882 6841da00 2019-08-08 stsp For compatibility with
883 bd8de430 2019-10-04 stsp .Xr cvs 1
884 bd8de430 2019-10-04 stsp and
885 bd8de430 2019-10-04 stsp .Xr git 1 ,
886 6841da00 2019-08-08 stsp .Cm got status
887 bd8de430 2019-10-04 stsp reads
888 bd8de430 2019-10-04 stsp .Xr glob 7
889 bd8de430 2019-10-04 stsp patterns from
890 6841da00 2019-08-08 stsp .Pa .cvsignore
891 bd8de430 2019-10-04 stsp and
892 bd8de430 2019-10-04 stsp .Pa .gitignore
893 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
894 bd8de430 2019-10-04 stsp which match these patterns.
895 1b5d300f 2023-02-20 thomas Ignore patterns which end with a slash,
896 1b5d300f 2023-02-20 thomas .Dq / ,
897 1b5d300f 2023-02-20 thomas will only match directories.
898 bd8de430 2019-10-04 stsp As an extension to
899 6841da00 2019-08-08 stsp .Xr glob 7
900 bd8de430 2019-10-04 stsp matching rules,
901 bd8de430 2019-10-04 stsp .Cm got status
902 bd8de430 2019-10-04 stsp supports consecutive asterisks,
903 bd8de430 2019-10-04 stsp .Dq ** ,
904 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
905 6841da00 2019-08-08 stsp Unlike
906 6841da00 2019-08-08 stsp .Xr cvs 1 ,
907 6841da00 2019-08-08 stsp .Cm got status
908 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
909 bd8de430 2019-10-04 stsp Unlike
910 bd8de430 2019-10-04 stsp .Xr git 1 ,
911 bd8de430 2019-10-04 stsp .Cm got status
912 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
913 bd8de430 2019-10-04 stsp .Dq \&! ,
914 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
915 bd8de430 2019-10-04 stsp .Dq / ,
916 bd8de430 2019-10-04 stsp in a pattern.
917 56c96eff 2022-08-30 thomas .It Xo
918 56c96eff 2022-08-30 thomas .Cm log
919 e6fdf1dd 2024-03-30 thomas .Op Fl bdPpRst
920 56c96eff 2022-08-30 thomas .Op Fl C Ar number
921 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
922 56c96eff 2022-08-30 thomas .Op Fl l Ar N
923 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
924 56c96eff 2022-08-30 thomas .Op Fl S Ar search-pattern
925 56c96eff 2022-08-30 thomas .Op Fl x Ar commit
926 56c96eff 2022-08-30 thomas .Op Ar path
927 56c96eff 2022-08-30 thomas .Xc
928 38e11793 2018-06-13 stsp Display history of a repository.
929 04ca23f4 2018-07-16 stsp If a
930 04ca23f4 2018-07-16 stsp .Ar path
931 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
932 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
933 dc990cbf 2020-02-22 stsp .Ar path
934 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
935 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
936 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
937 38e11793 2018-06-13 stsp .Pp
938 38e11793 2018-06-13 stsp The options for
939 38e11793 2018-06-13 stsp .Cm got log
940 38e11793 2018-06-13 stsp are as follows:
941 38e11793 2018-06-13 stsp .Bl -tag -width Ds
942 48c8c60d 2020-01-27 stsp .It Fl b
943 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
944 1137e0ae 2020-01-27 stsp from other branches.
945 48c8c60d 2020-01-27 stsp By default,
946 48c8c60d 2020-01-27 stsp .Cm got log
947 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
948 d6506a3d 2022-08-16 thomas .It Fl C Ar number
949 d6506a3d 2022-08-16 thomas Set the number of context lines shown in diffs with
950 d6506a3d 2022-08-16 thomas .Fl p .
951 d6506a3d 2022-08-16 thomas By default, 3 lines of context are shown.
952 38e11793 2018-06-13 stsp .It Fl c Ar commit
953 38e11793 2018-06-13 stsp Start traversing history at the specified
954 38e11793 2018-06-13 stsp .Ar commit .
955 482b0b83 2023-07-19 thomas If this option is not specified, default to the work tree's current branch
956 482b0b83 2023-07-19 thomas if invoked in a work tree, or to the repository's HEAD reference.
957 482b0b83 2023-07-19 thomas .Pp
958 482b0b83 2023-07-19 thomas The expected
959 482b0b83 2023-07-19 thomas .Ar commit
960 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
961 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
962 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
963 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
964 a290e4b4 2023-07-19 thomas The keywords
965 9139e004 2023-07-17 thomas .Qq :base
966 9139e004 2023-07-17 thomas and
967 9139e004 2023-07-17 thomas .Qq :head
968 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
969 9139e004 2023-07-17 thomas The former is only valid if invoked in a work tree, while the latter will
970 9139e004 2023-07-17 thomas resolve to the tip of the work tree's current branch if invoked in a
971 9139e004 2023-07-17 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
972 9139e004 2023-07-17 thomas Keywords and references may be appended with
973 9139e004 2023-07-17 thomas .Qq :+
974 9139e004 2023-07-17 thomas or
975 9139e004 2023-07-17 thomas .Qq :-
976 9139e004 2023-07-17 thomas modifiers and an optional integer N to denote the
977 9139e004 2023-07-17 thomas Nth descendant or antecedent, respectively, by first parent traversal;
978 9139e004 2023-07-17 thomas for example,
979 9139e004 2023-07-17 thomas .Sy :head:-2
980 9139e004 2023-07-17 thomas denotes the HEAD reference's 2nd generation ancestor, and
981 9139e004 2023-07-17 thomas .Sy :base:+4
982 9139e004 2023-07-17 thomas denotes the 4th generation descendant of the work tree's base commit.
983 9139e004 2023-07-17 thomas Similarly,
984 9139e004 2023-07-17 thomas .Sy bar:+3
985 9139e004 2023-07-17 thomas will denote the 3rd generation descendant of the commit resolved by the
986 9139e004 2023-07-17 thomas .Qq bar
987 9139e004 2023-07-17 thomas reference.
988 9139e004 2023-07-17 thomas A
989 9139e004 2023-07-17 thomas .Qq :+
990 9139e004 2023-07-17 thomas or
991 9139e004 2023-07-17 thomas .Qq :-
992 9139e004 2023-07-17 thomas modifier without a trailing integer has an implicit
993 9139e004 2023-07-17 thomas .Qq 1
994 9139e004 2023-07-17 thomas appended
995 9139e004 2023-07-17 thomas .Po e.g.,
996 9139e004 2023-07-17 thomas .Sy :base:+
997 9139e004 2023-07-17 thomas is equivalent to
998 9139e004 2023-07-17 thomas .Sy :base:+1
999 9139e004 2023-07-17 thomas .Pc .
1000 772fcad5 2023-01-07 thomas .It Fl d
1001 be97ab03 2023-01-19 thomas Display diffstat of changes introduced in each commit.
1002 772fcad5 2023-01-07 thomas Cannot be used with the
1003 772fcad5 2023-01-07 thomas .Fl s
1004 772fcad5 2023-01-07 thomas option.
1005 ba133bf3 2023-08-12 thomas Implies the
1006 ba133bf3 2023-08-12 thomas .Fl P
1007 ba133bf3 2023-08-12 thomas option (diffstat displays a list of changed paths).
1008 6238ee32 2018-06-13 stsp .It Fl l Ar N
1009 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
1010 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
1011 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
1012 b1ebc001 2019-08-13 stsp The
1013 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
1014 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
1015 0208f208 2020-05-05 stsp .It Fl P
1016 0208f208 2020-05-05 stsp Display the list of file paths changed in each commit, using the following
1017 0208f208 2020-05-05 stsp status codes:
1018 0208f208 2020-05-05 stsp .Bl -column YXZ description
1019 0208f208 2020-05-05 stsp .It M Ta modified file
1020 0208f208 2020-05-05 stsp .It D Ta file was deleted
1021 0208f208 2020-05-05 stsp .It A Ta new file was added
1022 0208f208 2020-05-05 stsp .It m Ta modified file modes (executable bit only)
1023 0208f208 2020-05-05 stsp .El
1024 e2f45bc4 2022-06-13 thomas .Pp
1025 2f7ada20 2022-06-13 thomas Cannot be used with the
1026 2f7ada20 2022-06-13 thomas .Fl s
1027 2f7ada20 2022-06-13 thomas option.
1028 d6506a3d 2022-08-16 thomas .It Fl p
1029 d6506a3d 2022-08-16 thomas Display the patch of modifications made in each commit.
1030 d6506a3d 2022-08-16 thomas If a
1031 d6506a3d 2022-08-16 thomas .Ar path
1032 d6506a3d 2022-08-16 thomas is specified, only show the patch of modifications at or within this path.
1033 d6506a3d 2022-08-16 thomas Cannot be used with the
1034 d6506a3d 2022-08-16 thomas .Fl s
1035 2f7ada20 2022-06-13 thomas option.
1036 d6506a3d 2022-08-16 thomas .It Fl R
1037 d6506a3d 2022-08-16 thomas Determine a set of commits to display as usual, but display these commits
1038 d6506a3d 2022-08-16 thomas in reverse order.
1039 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1040 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1041 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1042 d6506a3d 2022-08-16 thomas working directory.
1043 d6506a3d 2022-08-16 thomas If this directory is a
1044 d6506a3d 2022-08-16 thomas .Nm
1045 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1046 2f7ada20 2022-06-13 thomas .It Fl S Ar search-pattern
1047 4fe9456b 2022-06-13 thomas If specified, show only commits with a log message, author name,
1048 4fe9456b 2022-06-13 thomas committer name, or ID SHA1 hash matched by the extended regular
1049 4fe9456b 2022-06-13 thomas expression
1050 6841bf13 2019-11-29 kn .Ar search-pattern .
1051 314444e4 2022-06-13 thomas Lines in committed patches will be matched if
1052 314444e4 2022-06-13 thomas .Fl p
1053 314444e4 2022-06-13 thomas is specified.
1054 314444e4 2022-06-13 thomas File paths changed by a commit will be matched if
1055 314444e4 2022-06-13 thomas .Fl P
1056 314444e4 2022-06-13 thomas is specified.
1057 6841bf13 2019-11-29 kn Regular expression syntax is documented in
1058 6841bf13 2019-11-29 kn .Xr re_format 7 .
1059 d6506a3d 2022-08-16 thomas .It Fl s
1060 d6506a3d 2022-08-16 thomas Display a short one-line summary of each commit, instead of the default
1061 d6506a3d 2022-08-16 thomas history format.
1062 d6506a3d 2022-08-16 thomas Cannot be used together with the
1063 d6506a3d 2022-08-16 thomas .Fl p
1064 d6506a3d 2022-08-16 thomas or
1065 d6506a3d 2022-08-16 thomas .Fl P
1066 d6506a3d 2022-08-16 thomas option.
1067 e6fdf1dd 2024-03-30 thomas .It Fl t
1068 e6fdf1dd 2024-03-30 thomas Display commits in topological order.
1069 e6fdf1dd 2024-03-30 thomas This option has no effect without the
1070 10125703 2024-03-30 thomas .Fl b
1071 e6fdf1dd 2024-03-30 thomas option because a linear history is sorted in topological order by definition.
1072 e6fdf1dd 2024-03-30 thomas Topological sorting is disabled by default because the present implementation
1073 e6fdf1dd 2024-03-30 thomas requires that commit history is fully traversed before any output can be shown.
1074 d1fe46f9 2020-04-18 stsp .It Fl x Ar commit
1075 4e20a648 2021-03-21 jrick Stop traversing commit history immediately after the specified
1076 d1fe46f9 2020-04-18 stsp .Ar commit
1077 52ab7958 2020-04-18 stsp has been traversed.
1078 ef153826 2023-08-08 thomas Like
1079 ef153826 2023-08-08 thomas .Fl c ,
1080 ef153826 2023-08-08 thomas the expected
1081 ef153826 2023-08-08 thomas .Ar commit
1082 ef153826 2023-08-08 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
1083 ef153826 2023-08-08 thomas which will be resolved to a commit ID.
1084 d1fe46f9 2020-04-18 stsp This option has no effect if the specified
1085 d1fe46f9 2020-04-18 stsp .Ar commit
1086 d1fe46f9 2020-04-18 stsp is never traversed.
1087 38e11793 2018-06-13 stsp .El
1088 e8aa341a 2021-10-08 thomas .Tg di
1089 56c96eff 2022-08-30 thomas .It Xo
1090 56c96eff 2022-08-30 thomas .Cm diff
1091 53d03f97 2023-01-10 thomas .Op Fl adPsw
1092 56c96eff 2022-08-30 thomas .Op Fl C Ar number
1093 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1094 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1095 56c96eff 2022-08-30 thomas .Op Ar object1 Ar object2 | Ar path ...
1096 56c96eff 2022-08-30 thomas .Xc
1097 d912d125 2021-11-04 thomas .Dl Pq alias: Cm di
1098 30f6c0c6 2021-10-08 thomas When invoked within a work tree without any arguments, display all
1099 bd81cfb7 2020-04-19 stsp local changes in the work tree.
1100 30f6c0c6 2021-10-08 thomas If one or more
1101 927df6b7 2019-02-10 stsp .Ar path
1102 30f6c0c6 2021-10-08 thomas arguments are specified, only show changes within the specified paths.
1103 927df6b7 2019-02-10 stsp .Pp
1104 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
1105 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
1106 d24820bf 2019-08-11 stsp corresponding objects.
1107 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
1108 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1109 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1110 30f6c0c6 2021-10-08 thomas If none of these interpretations produce a valid result or if the
1111 30f6c0c6 2021-10-08 thomas .Fl P
1112 30f6c0c6 2021-10-08 thomas option is used,
1113 30f6c0c6 2021-10-08 thomas and if
1114 30f6c0c6 2021-10-08 thomas .Cm got diff
1115 30f6c0c6 2021-10-08 thomas is running in a work tree, attempt to interpret the two arguments as paths.
1116 c0cc5c62 2018-10-18 stsp .Pp
1117 c0cc5c62 2018-10-18 stsp The options for
1118 c0cc5c62 2018-10-18 stsp .Cm got diff
1119 c0cc5c62 2018-10-18 stsp are as follows:
1120 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
1121 64453f7e 2020-11-21 stsp .It Fl a
1122 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
1123 d6506a3d 2022-08-16 thomas .It Fl C Ar number
1124 d6506a3d 2022-08-16 thomas Set the number of context lines shown in the diff.
1125 d6506a3d 2022-08-16 thomas By default, 3 lines of context are shown.
1126 cc8021af 2021-10-12 thomas .It Fl c Ar commit
1127 cc8021af 2021-10-12 thomas Show differences between commits in the repository.
1128 d6506a3d 2022-08-16 thomas This option may be used up to two times.
1129 cc8021af 2021-10-12 thomas When used only once, show differences between the specified
1130 cc8021af 2021-10-12 thomas .Ar commit
1131 cc8021af 2021-10-12 thomas and its first parent commit.
1132 cc8021af 2021-10-12 thomas When used twice, show differences between the two specified commits.
1133 cc8021af 2021-10-12 thomas .Pp
1134 482b0b83 2023-07-19 thomas If the
1135 482b0b83 2023-07-19 thomas .Fl c
1136 482b0b83 2023-07-19 thomas option is used, all non-option arguments will be interpreted as paths.
1137 482b0b83 2023-07-19 thomas If one or more such
1138 482b0b83 2023-07-19 thomas .Ar path
1139 482b0b83 2023-07-19 thomas arguments are provided, only show differences for the specified paths.
1140 482b0b83 2023-07-19 thomas .Pp
1141 482b0b83 2023-07-19 thomas The expected
1142 482b0b83 2023-07-19 thomas .Ar commit
1143 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
1144 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
1145 cc8021af 2021-10-12 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
1146 cc8021af 2021-10-12 thomas automatically, provided the abbreviation is unique.
1147 a290e4b4 2023-07-19 thomas The keywords
1148 9139e004 2023-07-17 thomas .Qq :base
1149 9139e004 2023-07-17 thomas and
1150 9139e004 2023-07-17 thomas .Qq :head
1151 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1152 9139e004 2023-07-17 thomas The former is only valid if invoked in a work tree, while the latter will
1153 9139e004 2023-07-17 thomas resolve to the tip of the work tree's current branch if invoked in a
1154 9139e004 2023-07-17 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1155 9139e004 2023-07-17 thomas Keywords and references may be appended with
1156 9139e004 2023-07-17 thomas .Qq :+
1157 9139e004 2023-07-17 thomas or
1158 9139e004 2023-07-17 thomas .Qq :-
1159 9139e004 2023-07-17 thomas modifiers and an optional integer N to denote the
1160 9139e004 2023-07-17 thomas Nth descendant or antecedent, respectively, by first parent traversal;
1161 9139e004 2023-07-17 thomas for example,
1162 9139e004 2023-07-17 thomas .Sy :head:-2
1163 9139e004 2023-07-17 thomas denotes the HEAD reference's 2nd generation ancestor, and
1164 9139e004 2023-07-17 thomas .Sy :base:+4
1165 9139e004 2023-07-17 thomas denotes the 4th generation descendant of the work tree's base commit.
1166 9139e004 2023-07-17 thomas Similarly,
1167 9139e004 2023-07-17 thomas .Sy baz:+8
1168 9139e004 2023-07-17 thomas will denote the 8th generation descendant of the commit resolved by the
1169 9139e004 2023-07-17 thomas .Qq baz
1170 9139e004 2023-07-17 thomas reference.
1171 9139e004 2023-07-17 thomas If an integer does not follow the
1172 9139e004 2023-07-17 thomas .Qq :+
1173 9139e004 2023-07-17 thomas or
1174 9139e004 2023-07-17 thomas .Qq :-
1175 9139e004 2023-07-17 thomas modifier, a
1176 9139e004 2023-07-17 thomas .Qq 1
1177 9139e004 2023-07-17 thomas is implicitly appended
1178 9139e004 2023-07-17 thomas .Po e.g.,
1179 9139e004 2023-07-17 thomas .Sy :head:-
1180 9139e004 2023-07-17 thomas is equivalent to
1181 9139e004 2023-07-17 thomas .Sy :head:-1
1182 9139e004 2023-07-17 thomas .Pc .
1183 cc8021af 2021-10-12 thomas .Pp
1184 cc8021af 2021-10-12 thomas Cannot be used together with the
1185 cc8021af 2021-10-12 thomas .Fl P
1186 cc8021af 2021-10-12 thomas option.
1187 53d03f97 2023-01-10 thomas .It Fl d
1188 53d03f97 2023-01-10 thomas Display diffstat of changes before the actual diff by annotating each file path
1189 53d03f97 2023-01-10 thomas or blob hash being diffed with the total number of lines added and removed.
1190 53d03f97 2023-01-10 thomas A summary line will display the total number of changes across all files.
1191 d6506a3d 2022-08-16 thomas .It Fl P
1192 d6506a3d 2022-08-16 thomas Interpret all arguments as paths only.
1193 d6506a3d 2022-08-16 thomas This option can be used to resolve ambiguity in cases where paths
1194 d6506a3d 2022-08-16 thomas look like tag names, reference names, or object IDs.
1195 d6506a3d 2022-08-16 thomas This option is only valid when
1196 d6506a3d 2022-08-16 thomas .Cm got diff
1197 d6506a3d 2022-08-16 thomas is invoked in a work tree.
1198 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
1199 b72f483a 2019-02-05 stsp Use the repository at the specified path.
1200 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
1201 b72f483a 2019-02-05 stsp working directory.
1202 b72f483a 2019-02-05 stsp If this directory is a
1203 b72f483a 2019-02-05 stsp .Nm
1204 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1205 4ed9f614 2019-08-04 stsp .It Fl s
1206 4ed9f614 2019-08-04 stsp Show changes staged with
1207 4ed9f614 2019-08-04 stsp .Cm got stage
1208 bd81cfb7 2020-04-19 stsp instead of showing local changes in the work tree.
1209 30f6c0c6 2021-10-08 thomas This option is only valid when
1210 30f6c0c6 2021-10-08 thomas .Cm got diff
1211 30f6c0c6 2021-10-08 thomas is invoked in a work tree.
1212 63035f9f 2019-10-06 stsp .It Fl w
1213 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
1214 c0cc5c62 2018-10-18 stsp .El
1215 e8aa341a 2021-10-08 thomas .Tg bl
1216 56c96eff 2022-08-30 thomas .It Xo
1217 56c96eff 2022-08-30 thomas .Cm blame
1218 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1219 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1220 56c96eff 2022-08-30 thomas .Ar path
1221 56c96eff 2022-08-30 thomas .Xc
1222 d912d125 2021-11-04 thomas .Dl Pq alias: Cm bl
1223 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
1224 1ff8e573 2018-08-02 stsp .Pp
1225 1ff8e573 2018-08-02 stsp The options for
1226 1ff8e573 2018-08-02 stsp .Cm got blame
1227 1ff8e573 2018-08-02 stsp are as follows:
1228 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
1229 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
1230 1ff8e573 2018-08-02 stsp Start traversing history at the specified
1231 1ff8e573 2018-08-02 stsp .Ar commit .
1232 9f625d2d 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name
1233 9f625d2d 2023-07-19 thomas or a keyword which will be resolved to a commit ID.
1234 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1235 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1236 9f625d2d 2023-07-19 thomas The keywords
1237 3795e2b6 2023-07-19 thomas .Qq :base
1238 3795e2b6 2023-07-19 thomas and
1239 3795e2b6 2023-07-19 thomas .Qq :head
1240 9f625d2d 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1241 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1242 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1243 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1244 3795e2b6 2023-07-19 thomas Keywords and references may be appended with
1245 3795e2b6 2023-07-19 thomas .Qq :+
1246 3795e2b6 2023-07-19 thomas or
1247 3795e2b6 2023-07-19 thomas .Qq :-
1248 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
1249 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1250 3795e2b6 2023-07-19 thomas for example,
1251 3795e2b6 2023-07-19 thomas .Sy :head:-2
1252 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1253 3795e2b6 2023-07-19 thomas .Sy :base:+4
1254 3795e2b6 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1255 3795e2b6 2023-07-19 thomas Similarly,
1256 3795e2b6 2023-07-19 thomas .Sy xyz:-5
1257 3795e2b6 2023-07-19 thomas will denote the 5th generation ancestor of the commit resolved by the
1258 3795e2b6 2023-07-19 thomas .Qq xyz
1259 3795e2b6 2023-07-19 thomas reference.
1260 3795e2b6 2023-07-19 thomas A
1261 3795e2b6 2023-07-19 thomas .Qq :+
1262 3795e2b6 2023-07-19 thomas or
1263 3795e2b6 2023-07-19 thomas .Qq :-
1264 3795e2b6 2023-07-19 thomas modifier without a trailing integer has an implicit
1265 3795e2b6 2023-07-19 thomas .Qq 1
1266 3795e2b6 2023-07-19 thomas appended
1267 3795e2b6 2023-07-19 thomas .Po e.g.,
1268 3795e2b6 2023-07-19 thomas .Sy :base:+
1269 3795e2b6 2023-07-19 thomas is equivalent to
1270 3795e2b6 2023-07-19 thomas .Sy :base:+1
1271 3795e2b6 2023-07-19 thomas .Pc .
1272 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
1273 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
1274 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
1275 1ff8e573 2018-08-02 stsp working directory.
1276 0c06baac 2019-02-05 stsp If this directory is a
1277 0c06baac 2019-02-05 stsp .Nm
1278 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1279 5c860e29 2018-03-12 stsp .El
1280 e8aa341a 2021-10-08 thomas .Tg tr
1281 56c96eff 2022-08-30 thomas .It Xo
1282 56c96eff 2022-08-30 thomas .Cm tree
1283 56c96eff 2022-08-30 thomas .Op Fl iR
1284 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1285 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1286 56c96eff 2022-08-30 thomas .Op Ar path
1287 56c96eff 2022-08-30 thomas .Xc
1288 d912d125 2021-11-04 thomas .Dl Pq alias: Cm tr
1289 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
1290 5de5890b 2018-10-18 stsp directory path in the repository.
1291 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
1292 db0c2996 2019-02-10 stsp annotations:
1293 db0c2996 2019-02-10 stsp .Bl -column YXZ description
1294 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
1295 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
1296 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
1297 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
1298 db0c2996 2019-02-10 stsp .El
1299 0d6c6ee3 2020-05-20 stsp .Pp
1300 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
1301 db0c2996 2019-02-10 stsp .Pp
1302 0c849583 2019-02-05 stsp If no
1303 0c849583 2019-02-05 stsp .Ar path
1304 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
1305 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
1306 0c849583 2019-02-05 stsp if there is no work tree.
1307 5de5890b 2018-10-18 stsp .Pp
1308 5de5890b 2018-10-18 stsp The options for
1309 5de5890b 2018-10-18 stsp .Cm got tree
1310 5de5890b 2018-10-18 stsp are as follows:
1311 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
1312 5de5890b 2018-10-18 stsp .It Fl c Ar commit
1313 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
1314 5de5890b 2018-10-18 stsp .Ar commit .
1315 9f625d2d 2023-07-19 thomas .Pp
1316 9f625d2d 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name
1317 9f625d2d 2023-07-19 thomas or a keyword which will be resolved to a commit ID.
1318 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1319 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1320 9f625d2d 2023-07-19 thomas The keywords
1321 3795e2b6 2023-07-19 thomas .Qq :base
1322 3795e2b6 2023-07-19 thomas and
1323 3795e2b6 2023-07-19 thomas .Qq :head
1324 9f625d2d 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1325 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1326 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1327 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1328 3795e2b6 2023-07-19 thomas Keywords and references may be appended with
1329 3795e2b6 2023-07-19 thomas .Qq :+
1330 3795e2b6 2023-07-19 thomas or
1331 3795e2b6 2023-07-19 thomas .Qq :-
1332 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
1333 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1334 3795e2b6 2023-07-19 thomas for example,
1335 3795e2b6 2023-07-19 thomas .Sy :head:-2
1336 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1337 3795e2b6 2023-07-19 thomas .Sy :base:+4
1338 3795e2b6 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1339 3795e2b6 2023-07-19 thomas Similarly,
1340 3795e2b6 2023-07-19 thomas .Sy spam:-3
1341 3795e2b6 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
1342 3795e2b6 2023-07-19 thomas .Qq spam
1343 3795e2b6 2023-07-19 thomas reference.
1344 3795e2b6 2023-07-19 thomas A
1345 3795e2b6 2023-07-19 thomas .Qq :+
1346 3795e2b6 2023-07-19 thomas or
1347 3795e2b6 2023-07-19 thomas .Qq :-
1348 3795e2b6 2023-07-19 thomas modifier without a trailing integer has an implicit
1349 3795e2b6 2023-07-19 thomas .Qq 1
1350 3795e2b6 2023-07-19 thomas appended
1351 3795e2b6 2023-07-19 thomas .Po e.g.,
1352 3795e2b6 2023-07-19 thomas .Sy :base:+
1353 3795e2b6 2023-07-19 thomas is equivalent to
1354 3795e2b6 2023-07-19 thomas .Sy :base:+1
1355 3795e2b6 2023-07-19 thomas .Pc .
1356 d6506a3d 2022-08-16 thomas .It Fl i
1357 d6506a3d 2022-08-16 thomas Show object IDs of files (blob objects) and directories (tree objects).
1358 d6506a3d 2022-08-16 thomas .It Fl R
1359 d6506a3d 2022-08-16 thomas Recurse into sub-directories in the repository.
1360 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
1361 5de5890b 2018-10-18 stsp Use the repository at the specified path.
1362 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
1363 5de5890b 2018-10-18 stsp working directory.
1364 0c849583 2019-02-05 stsp If this directory is a
1365 0c849583 2019-02-05 stsp .Nm
1366 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1367 d0eebce4 2019-03-11 stsp .El
1368 56c96eff 2022-08-30 thomas .It Xo
1369 56c96eff 2022-08-30 thomas .Cm ref
1370 56c96eff 2022-08-30 thomas .Op Fl dlt
1371 b6b86fd1 2022-08-30 thomas .Op Fl c Ar object
1372 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1373 56c96eff 2022-08-30 thomas .Op Fl s Ar reference
1374 56c96eff 2022-08-30 thomas .Op Ar name
1375 56c96eff 2022-08-30 thomas .Xc
1376 d0eebce4 2019-03-11 stsp Manage references in a repository.
1377 d0eebce4 2019-03-11 stsp .Pp
1378 e31abbf2 2020-03-22 stsp References may be listed, created, deleted, and changed.
1379 e31abbf2 2020-03-22 stsp When creating, deleting, or changing a reference the specified
1380 e31abbf2 2020-03-22 stsp .Ar name
1381 e31abbf2 2020-03-22 stsp must be an absolute reference name, i.e. it must begin with
1382 f16e4044 2019-10-09 stsp .Dq refs/ .
1383 e31abbf2 2020-03-22 stsp .Pp
1384 d0eebce4 2019-03-11 stsp The options for
1385 d0eebce4 2019-03-11 stsp .Cm got ref
1386 d0eebce4 2019-03-11 stsp are as follows:
1387 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
1388 d6506a3d 2022-08-16 thomas .It Fl c Ar object
1389 d6506a3d 2022-08-16 thomas Create a reference or change an existing reference.
1390 d6506a3d 2022-08-16 thomas The reference with the specified
1391 d6506a3d 2022-08-16 thomas .Ar name
1392 d6506a3d 2022-08-16 thomas will point at the specified
1393 d6506a3d 2022-08-16 thomas .Ar object .
1394 3795e2b6 2023-07-19 thomas .Pp
1395 d6506a3d 2022-08-16 thomas The expected
1396 d6506a3d 2022-08-16 thomas .Ar object
1397 3795e2b6 2023-07-19 thomas argument is an ID SHA1 hash or an existing reference or tag name
1398 3795e2b6 2023-07-19 thomas or a keyword which will be resolved to the ID of a corresponding commit,
1399 3795e2b6 2023-07-19 thomas tree, tag, or blob object.
1400 3795e2b6 2023-07-19 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
1401 3795e2b6 2023-07-19 thomas automatically, provided the abbreviation is unique.
1402 3795e2b6 2023-07-19 thomas The keywords
1403 3795e2b6 2023-07-19 thomas .Qq :base
1404 3795e2b6 2023-07-19 thomas and
1405 3795e2b6 2023-07-19 thomas .Qq :head
1406 3795e2b6 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1407 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1408 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1409 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1410 3795e2b6 2023-07-19 thomas Keywords and reference names may be appended with
1411 3795e2b6 2023-07-19 thomas .Qq :+
1412 3795e2b6 2023-07-19 thomas or
1413 3795e2b6 2023-07-19 thomas .Qq :-
1414 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
1415 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1416 3795e2b6 2023-07-19 thomas for example,
1417 3795e2b6 2023-07-19 thomas .Sy :head:-2
1418 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1419 3795e2b6 2023-07-19 thomas .Sy tagged:-3
1420 3795e2b6 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
1421 3795e2b6 2023-07-19 thomas .Qq tagged
1422 3795e2b6 2023-07-19 thomas reference.
1423 3795e2b6 2023-07-19 thomas If an integer does not follow the
1424 3795e2b6 2023-07-19 thomas .Qq :+
1425 3795e2b6 2023-07-19 thomas or
1426 3795e2b6 2023-07-19 thomas .Qq :-
1427 3795e2b6 2023-07-19 thomas modifier, a
1428 3795e2b6 2023-07-19 thomas .Qq 1
1429 3795e2b6 2023-07-19 thomas is implicitly appended
1430 3795e2b6 2023-07-19 thomas .Po e.g.,
1431 3795e2b6 2023-07-19 thomas .Sy :head:-
1432 3795e2b6 2023-07-19 thomas is equivalent to
1433 3795e2b6 2023-07-19 thomas .Sy :head:-1
1434 3795e2b6 2023-07-19 thomas .Pc .
1435 3795e2b6 2023-07-19 thomas .Pp
1436 d6506a3d 2022-08-16 thomas Cannot be used together with any other options except
1437 d6506a3d 2022-08-16 thomas .Fl r .
1438 d6506a3d 2022-08-16 thomas .It Fl d
1439 d6506a3d 2022-08-16 thomas Delete the reference with the specified
1440 d6506a3d 2022-08-16 thomas .Ar name
1441 d6506a3d 2022-08-16 thomas from the repository.
1442 d6506a3d 2022-08-16 thomas Any commit, tree, tag, and blob objects belonging to deleted references
1443 d6506a3d 2022-08-16 thomas remain in the repository and may be removed separately with
1444 d6506a3d 2022-08-16 thomas Git's garbage collector or
1445 d6506a3d 2022-08-16 thomas .Cm gotadmin cleanup .
1446 d6506a3d 2022-08-16 thomas Cannot be used together with any other options except
1447 d6506a3d 2022-08-16 thomas .Fl r .
1448 d0eebce4 2019-03-11 stsp .It Fl l
1449 b2070a3f 2020-03-22 stsp List references in the repository.
1450 b2070a3f 2020-03-22 stsp If no
1451 b2070a3f 2020-03-22 stsp .Ar name
1452 b2070a3f 2020-03-22 stsp is specified, list all existing references in the repository.
1453 b2070a3f 2020-03-22 stsp If
1454 b2070a3f 2020-03-22 stsp .Ar name
1455 b2070a3f 2020-03-22 stsp is a reference namespace, list all references in this namespace.
1456 b2070a3f 2020-03-22 stsp Otherwise, show only the reference with the given
1457 b2070a3f 2020-03-22 stsp .Ar name .
1458 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1459 2bf0fa54 2021-11-20 thomas .Fl r
1460 2bf0fa54 2021-11-20 thomas and
1461 2bf0fa54 2021-11-20 thomas .Fl t .
1462 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1463 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1464 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1465 d6506a3d 2022-08-16 thomas working directory.
1466 d6506a3d 2022-08-16 thomas If this directory is a
1467 d6506a3d 2022-08-16 thomas .Nm
1468 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1469 e31abbf2 2020-03-22 stsp .It Fl s Ar reference
1470 e31abbf2 2020-03-22 stsp Create a symbolic reference, or change an existing symbolic reference.
1471 e31abbf2 2020-03-22 stsp The symbolic reference with the specified
1472 e31abbf2 2020-03-22 stsp .Ar name
1473 e31abbf2 2020-03-22 stsp will point at the specified
1474 e31abbf2 2020-03-22 stsp .Ar reference
1475 e31abbf2 2020-03-22 stsp which must already exist in the repository.
1476 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
1477 d1c1ae5f 2019-08-12 stsp this option is used.
1478 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1479 e31abbf2 2020-03-22 stsp .Fl r .
1480 d6506a3d 2022-08-16 thomas .It Fl t
1481 d6506a3d 2022-08-16 thomas Sort listed references by modification time (most recently modified first)
1482 d6506a3d 2022-08-16 thomas instead of sorting by lexicographical order.
1483 d6506a3d 2022-08-16 thomas Use of this option requires the
1484 d6506a3d 2022-08-16 thomas .Fl l
1485 d6506a3d 2022-08-16 thomas option to be used as well.
1486 4e759de4 2019-06-26 stsp .El
1487 e8aa341a 2021-10-08 thomas .Tg br
1488 56c96eff 2022-08-30 thomas .It Xo
1489 56c96eff 2022-08-30 thomas .Cm branch
1490 56c96eff 2022-08-30 thomas .Op Fl lnt
1491 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1492 56c96eff 2022-08-30 thomas .Op Fl d Ar name
1493 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1494 56c96eff 2022-08-30 thomas .Op Ar name
1495 56c96eff 2022-08-30 thomas .Xc
1496 d912d125 2021-11-04 thomas .Dl Pq alias: Cm br
1497 da76fce2 2020-02-24 stsp Create, list, or delete branches.
1498 4e759de4 2019-06-26 stsp .Pp
1499 34d4e04c 2021-02-08 stsp Local branches are managed via references which live in the
1500 4e759de4 2019-06-26 stsp .Dq refs/heads/
1501 4e759de4 2019-06-26 stsp reference namespace.
1502 4e759de4 2019-06-26 stsp The
1503 4e759de4 2019-06-26 stsp .Cm got branch
1504 2f1457c6 2021-08-27 stsp command creates references in this namespace only.
1505 2f1457c6 2021-08-27 stsp .Pp
1506 4b06140e 2022-03-22 thomas When deleting branches, the specified
1507 2f1457c6 2021-08-27 stsp .Ar name
1508 2f1457c6 2021-08-27 stsp is searched in the
1509 2f1457c6 2021-08-27 stsp .Dq refs/heads
1510 2f1457c6 2021-08-27 stsp reference namespace first.
1511 4b06140e 2022-03-22 thomas If no corresponding branch is found, the
1512 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1513 2f1457c6 2021-08-27 stsp namespace will be searched next.
1514 4e759de4 2019-06-26 stsp .Pp
1515 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1516 ad89fa31 2019-10-04 stsp work tree's current branch.
1517 da76fce2 2020-02-24 stsp .Pp
1518 a74f7e83 2019-11-10 stsp If a
1519 a74f7e83 2019-11-10 stsp .Ar name
1520 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1521 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1522 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1523 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1524 4e759de4 2019-06-26 stsp .Pp
1525 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1526 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1527 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1528 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1529 da76fce2 2020-02-24 stsp would do.
1530 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1531 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1532 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1533 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1534 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1535 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1536 da76fce2 2020-02-24 stsp .It A Ta new file was added
1537 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1538 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1539 da76fce2 2020-02-24 stsp .El
1540 da76fce2 2020-02-24 stsp .Pp
1541 4e759de4 2019-06-26 stsp The options for
1542 4e759de4 2019-06-26 stsp .Cm got branch
1543 4e759de4 2019-06-26 stsp are as follows:
1544 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
1545 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1546 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1547 a74f7e83 2019-11-10 stsp .Ar commit .
1548 a290e4b4 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name or keyword
1549 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
1550 a290e4b4 2023-07-19 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
1551 a290e4b4 2023-07-19 thomas automatically, provided the abbreviation is unique.
1552 a290e4b4 2023-07-19 thomas The keywords
1553 fb885120 2023-07-19 thomas .Qq :base
1554 fb885120 2023-07-19 thomas and
1555 fb885120 2023-07-19 thomas .Qq :head
1556 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1557 fb885120 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1558 fb885120 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1559 fb885120 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1560 fb885120 2023-07-19 thomas Keywords and references may be appended with
1561 fb885120 2023-07-19 thomas .Qq :+
1562 fb885120 2023-07-19 thomas or
1563 fb885120 2023-07-19 thomas .Qq :-
1564 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
1565 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1566 fb885120 2023-07-19 thomas for example,
1567 fb885120 2023-07-19 thomas .Sy :head:-2
1568 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1569 fb885120 2023-07-19 thomas .Sy :base:+4
1570 fb885120 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1571 fb885120 2023-07-19 thomas Similarly,
1572 fb885120 2023-07-19 thomas .Sy foobar:+3
1573 fb885120 2023-07-19 thomas will denote the 3rd generation descendant of the commit resolved by the
1574 fb885120 2023-07-19 thomas .Qq foobar
1575 fb885120 2023-07-19 thomas reference.
1576 fb885120 2023-07-19 thomas A
1577 fb885120 2023-07-19 thomas .Qq :+
1578 fb885120 2023-07-19 thomas or
1579 fb885120 2023-07-19 thomas .Qq :-
1580 fb885120 2023-07-19 thomas modifier without a trailing integer has an implicit
1581 fb885120 2023-07-19 thomas .Qq 1
1582 fb885120 2023-07-19 thomas appended
1583 fb885120 2023-07-19 thomas .Po e.g.,
1584 fb885120 2023-07-19 thomas .Sy :base:+
1585 fb885120 2023-07-19 thomas is equivalent to
1586 fb885120 2023-07-19 thomas .Sy :base:+1
1587 fb885120 2023-07-19 thomas .Pc .
1588 d6506a3d 2022-08-16 thomas .It Fl d Ar name
1589 d6506a3d 2022-08-16 thomas Delete the branch with the specified
1590 d6506a3d 2022-08-16 thomas .Ar name
1591 d6506a3d 2022-08-16 thomas from the
1592 d6506a3d 2022-08-16 thomas .Dq refs/heads
1593 d6506a3d 2022-08-16 thomas or
1594 d6506a3d 2022-08-16 thomas .Dq refs/remotes
1595 d6506a3d 2022-08-16 thomas reference namespace.
1596 d6506a3d 2022-08-16 thomas .Pp
1597 d6506a3d 2022-08-16 thomas Only the branch reference is deleted.
1598 d6506a3d 2022-08-16 thomas Any commit, tree, and blob objects belonging to the branch
1599 d6506a3d 2022-08-16 thomas remain in the repository and may be removed separately with
1600 d6506a3d 2022-08-16 thomas Git's garbage collector or
1601 d6506a3d 2022-08-16 thomas .Cm gotadmin cleanup .
1602 4e759de4 2019-06-26 stsp .It Fl l
1603 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1604 34d4e04c 2021-02-08 stsp repositories' branches in the
1605 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1606 34d4e04c 2021-02-08 stsp reference namespace.
1607 34d4e04c 2021-02-08 stsp .Pp
1608 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1609 87c986b7 2023-07-05 thomas with one of the following annotations:
1610 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1611 44d79efa 2023-07-23 thomas .It * Ta work tree's base commit and the base commit of all tracked files
1612 44d79efa 2023-07-23 thomas matches the branch tip
1613 44d79efa 2023-07-23 thomas .It \(a~ Ta work tree comprises mixed commits or its base commit is out-of-date
1614 ba882ee3 2019-07-11 stsp .El
1615 d6506a3d 2022-08-16 thomas .It Fl n
1616 d6506a3d 2022-08-16 thomas Do not switch and update the work tree after creating a new branch.
1617 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1618 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1619 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1620 d6506a3d 2022-08-16 thomas working directory.
1621 d6506a3d 2022-08-16 thomas If this directory is a
1622 d6506a3d 2022-08-16 thomas .Nm
1623 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1624 a0b48eaf 2021-11-20 thomas .It Fl t
1625 a0b48eaf 2021-11-20 thomas Sort listed branches by modification time (most recently modified first)
1626 a0b48eaf 2021-11-20 thomas instead of sorting by lexicographical order.
1627 a0b48eaf 2021-11-20 thomas Branches in the
1628 a0b48eaf 2021-11-20 thomas .Dq refs/heads/
1629 a0b48eaf 2021-11-20 thomas reference namespace are listed before branches in
1630 a0b48eaf 2021-11-20 thomas .Dq refs/remotes/
1631 a0b48eaf 2021-11-20 thomas regardless.
1632 a0b48eaf 2021-11-20 thomas Use of this option requires the
1633 a0b48eaf 2021-11-20 thomas .Fl l
1634 a0b48eaf 2021-11-20 thomas option to be used as well.
1635 5de5890b 2018-10-18 stsp .El
1636 56c96eff 2022-08-30 thomas .It Xo
1637 56c96eff 2022-08-30 thomas .Cm tag
1638 56c96eff 2022-08-30 thomas .Op Fl lVv
1639 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1640 56c96eff 2022-08-30 thomas .Op Fl m Ar message
1641 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1642 56c96eff 2022-08-30 thomas .Op Fl s Ar signer-id
1643 56c96eff 2022-08-30 thomas .Ar name
1644 56c96eff 2022-08-30 thomas .Xc
1645 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1646 8e7bd50a 2019-08-22 stsp .Pp
1647 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1648 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1649 8e7bd50a 2019-08-22 stsp reference namespace.
1650 8e7bd50a 2019-08-22 stsp The
1651 8e7bd50a 2019-08-22 stsp .Cm got tag
1652 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1653 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1654 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1655 8e7bd50a 2019-08-22 stsp .Pp
1656 80106605 2020-02-24 stsp Attempt to create a tag with the given
1657 8e7bd50a 2019-08-22 stsp .Ar name ,
1658 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1659 8e7bd50a 2019-08-22 stsp .Ar commit .
1660 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1661 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1662 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1663 8e7bd50a 2019-08-22 stsp .Pp
1664 8e7bd50a 2019-08-22 stsp The options for
1665 8e7bd50a 2019-08-22 stsp .Cm got tag
1666 8e7bd50a 2019-08-22 stsp are as follows:
1667 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1668 80106605 2020-02-24 stsp .It Fl c Ar commit
1669 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1670 80106605 2020-02-24 stsp .Ar commit .
1671 80106605 2020-02-24 stsp The expected
1672 80106605 2020-02-24 stsp .Ar commit
1673 9f625d2d 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference or keyword
1674 9f625d2d 2023-07-19 thomas which will be resolved to a commit ID.
1675 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1676 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1677 9f625d2d 2023-07-19 thomas The keywords
1678 3795e2b6 2023-07-19 thomas .Qq :base
1679 3795e2b6 2023-07-19 thomas and
1680 3795e2b6 2023-07-19 thomas .Qq :head
1681 9f625d2d 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1682 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1683 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1684 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1685 3795e2b6 2023-07-19 thomas Keywords and references may be appended with
1686 3795e2b6 2023-07-19 thomas .Qq :+
1687 3795e2b6 2023-07-19 thomas or
1688 3795e2b6 2023-07-19 thomas .Qq :-
1689 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
1690 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1691 3795e2b6 2023-07-19 thomas for example,
1692 3795e2b6 2023-07-19 thomas .Sy :head:-2
1693 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1694 3795e2b6 2023-07-19 thomas .Sy :base:+4
1695 3795e2b6 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1696 3795e2b6 2023-07-19 thomas Similarly,
1697 3795e2b6 2023-07-19 thomas .Sy eggs:-3
1698 3795e2b6 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
1699 3795e2b6 2023-07-19 thomas .Qq eggs
1700 3795e2b6 2023-07-19 thomas reference.
1701 3795e2b6 2023-07-19 thomas A
1702 3795e2b6 2023-07-19 thomas .Qq :+
1703 3795e2b6 2023-07-19 thomas or
1704 3795e2b6 2023-07-19 thomas .Qq :-
1705 3795e2b6 2023-07-19 thomas modifier without a trailing integer has an implicit
1706 3795e2b6 2023-07-19 thomas .Qq 1
1707 3795e2b6 2023-07-19 thomas appended
1708 3795e2b6 2023-07-19 thomas .Po e.g.,
1709 3795e2b6 2023-07-19 thomas .Sy :base:+
1710 3795e2b6 2023-07-19 thomas is equivalent to
1711 3795e2b6 2023-07-19 thomas .Sy :base:+1
1712 3795e2b6 2023-07-19 thomas .Pc .
1713 d6506a3d 2022-08-16 thomas .It Fl l
1714 d6506a3d 2022-08-16 thomas List all existing tags in the repository instead of creating a new tag.
1715 d6506a3d 2022-08-16 thomas If a
1716 d6506a3d 2022-08-16 thomas .Ar name
1717 d6506a3d 2022-08-16 thomas argument is passed, show only the tag with the given
1718 d6506a3d 2022-08-16 thomas .Ar name .
1719 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
1720 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
1721 8e7bd50a 2019-08-22 stsp Without the
1722 8e7bd50a 2019-08-22 stsp .Fl m
1723 8e7bd50a 2019-08-22 stsp option,
1724 3a62228f 2019-11-08 stsp .Cm got tag
1725 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
1726 bccae03f 2023-07-17 thomas Quitting the editor without saving the file will abort the tag operation.
1727 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
1728 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
1729 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1730 8e7bd50a 2019-08-22 stsp working directory.
1731 8e7bd50a 2019-08-22 stsp If this directory is a
1732 8e7bd50a 2019-08-22 stsp .Nm
1733 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1734 839dd04f 2022-07-04 thomas .It Fl s Ar signer-id
1735 839dd04f 2022-07-04 thomas While creating a new tag, sign this tag with the identity given in
1736 839dd04f 2022-07-04 thomas .Ar signer-id .
1737 839dd04f 2022-07-04 thomas .Pp
1738 839dd04f 2022-07-04 thomas For SSH-based signatures,
1739 839dd04f 2022-07-04 thomas .Ar signer-id
1740 839dd04f 2022-07-04 thomas is the path to a file which may refer to either a private SSH key,
1741 839dd04f 2022-07-04 thomas or a public SSH key with the private half available via
1742 839dd04f 2022-07-04 thomas .Xr ssh-agent 1 .
1743 839dd04f 2022-07-04 thomas .Cm got tag
1744 839dd04f 2022-07-04 thomas will sign the tag object by invoking
1745 839dd04f 2022-07-04 thomas .Xr ssh-keygen 1
1746 839dd04f 2022-07-04 thomas with the
1747 b6bfeb85 2022-08-16 thomas .Fl Y Cm sign
1748 839dd04f 2022-07-04 thomas command, using the signature namespace
1749 839dd04f 2022-07-04 thomas .Dq git
1750 839dd04f 2022-07-04 thomas for compatibility with
1751 839dd04f 2022-07-04 thomas .Xr git 1 .
1752 839dd04f 2022-07-04 thomas .It Fl V
1753 839dd04f 2022-07-04 thomas Verify tag object signatures.
1754 839dd04f 2022-07-04 thomas If a
1755 839dd04f 2022-07-04 thomas .Ar name
1756 839dd04f 2022-07-04 thomas is specified, show and verify the tag object with the provided name.
1757 839dd04f 2022-07-04 thomas Otherwise, list all tag objects and verify signatures where present.
1758 839dd04f 2022-07-04 thomas .Pp
1759 839dd04f 2022-07-04 thomas .Cm got tag
1760 839dd04f 2022-07-04 thomas verifies SSH-based signatures by invoking
1761 839dd04f 2022-07-04 thomas .Xr ssh-keygen 1
1762 839dd04f 2022-07-04 thomas with the options
1763 b6bfeb85 2022-08-16 thomas .Fl Y Cm verify Fl f Ar allowed_signers .
1764 839dd04f 2022-07-04 thomas A path to the
1765 839dd04f 2022-07-04 thomas .Ar allowed_signers
1766 839dd04f 2022-07-04 thomas file must be set in
1767 839dd04f 2022-07-04 thomas .Xr got.conf 5 ,
1768 839dd04f 2022-07-04 thomas otherwise verification is impossible.
1769 d6506a3d 2022-08-16 thomas .It Fl v
1770 d6506a3d 2022-08-16 thomas Verbose mode.
1771 d6506a3d 2022-08-16 thomas During SSH signature creation and verification this option will be passed to
1772 d6506a3d 2022-08-16 thomas .Xr ssh-keygen 1 .
1773 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
1774 d6506a3d 2022-08-16 thomas The maximum is 3.
1775 8e7bd50a 2019-08-22 stsp .El
1776 8e7bd50a 2019-08-22 stsp .Pp
1777 8e7bd50a 2019-08-22 stsp By design, the
1778 8e7bd50a 2019-08-22 stsp .Cm got tag
1779 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1780 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1781 8e7bd50a 2019-08-22 stsp .Cm got ref
1782 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1783 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1784 8e7bd50a 2019-08-22 stsp another repository.
1785 56c96eff 2022-08-30 thomas .It Xo
1786 56c96eff 2022-08-30 thomas .Cm add
1787 56c96eff 2022-08-30 thomas .Op Fl IR
1788 56c96eff 2022-08-30 thomas .Ar path ...
1789 56c96eff 2022-08-30 thomas .Xc
1790 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1791 d00136be 2019-03-26 stsp repository in the next commit.
1792 ff56836b 2021-07-08 stsp By default, files which match a
1793 ff56836b 2021-07-08 stsp .Cm got status
1794 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1795 4e68cba3 2019-11-23 stsp .Pp
1796 b21ebdb0 2023-06-22 thomas If a
1797 b21ebdb0 2023-06-22 thomas .Ar path
1798 b21ebdb0 2023-06-22 thomas mentioned in the command line is not an unversioned file then
1799 b21ebdb0 2023-06-22 thomas .Cm got add
1800 b21ebdb0 2023-06-22 thomas may raise an error.
1801 b21ebdb0 2023-06-22 thomas To avoid unnecessary errors from paths picked up by file globbing patterns
1802 b21ebdb0 2023-06-22 thomas in the shell, paths in the argument list will be silently ignored if they
1803 b21ebdb0 2023-06-22 thomas are not reported by
1804 b21ebdb0 2023-06-22 thomas .Cm got status
1805 b21ebdb0 2023-06-22 thomas at all, or if they are reported with one of the following status codes
1806 b21ebdb0 2023-06-22 thomas and do not have changes staged via
1807 b21ebdb0 2023-06-22 thomas .Cm got stage :
1808 b21ebdb0 2023-06-22 thomas .Bl -column YXZ description
1809 b21ebdb0 2023-06-22 thomas .It M Ta modified file
1810 b21ebdb0 2023-06-22 thomas .It A Ta file scheduled for addition in next commit
1811 b21ebdb0 2023-06-22 thomas .It C Ta modified or added file which contains merge conflicts
1812 b21ebdb0 2023-06-22 thomas .It m Ta modified file modes (executable bit only)
1813 b21ebdb0 2023-06-22 thomas .El
1814 b21ebdb0 2023-06-22 thomas .Pp
1815 4e68cba3 2019-11-23 stsp The options for
1816 4e68cba3 2019-11-23 stsp .Cm got add
1817 4e68cba3 2019-11-23 stsp are as follows:
1818 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1819 d6506a3d 2022-08-16 thomas .It Fl I
1820 d6506a3d 2022-08-16 thomas Add files even if they match a
1821 d6506a3d 2022-08-16 thomas .Cm got status
1822 d6506a3d 2022-08-16 thomas ignore pattern.
1823 4e68cba3 2019-11-23 stsp .It Fl R
1824 4e68cba3 2019-11-23 stsp Permit recursion into directories.
1825 4e68cba3 2019-11-23 stsp If this option is not specified,
1826 4e68cba3 2019-11-23 stsp .Cm got add
1827 4e68cba3 2019-11-23 stsp will refuse to run if a specified
1828 4e68cba3 2019-11-23 stsp .Ar path
1829 4e68cba3 2019-11-23 stsp is a directory.
1830 4e68cba3 2019-11-23 stsp .El
1831 e8aa341a 2021-10-08 thomas .Tg rm
1832 56c96eff 2022-08-30 thomas .It Xo
1833 56c96eff 2022-08-30 thomas .Cm remove
1834 56c96eff 2022-08-30 thomas .Op Fl fkR
1835 56c96eff 2022-08-30 thomas .Op Fl s Ar status-codes
1836 56c96eff 2022-08-30 thomas .Ar path ...
1837 56c96eff 2022-08-30 thomas .Xc
1838 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rm
1839 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1840 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1841 2ec1f75b 2019-03-26 stsp .Pp
1842 2ec1f75b 2019-03-26 stsp The options for
1843 86d25a1b 2019-07-11 stsp .Cm got remove
1844 2ec1f75b 2019-03-26 stsp are as follows:
1845 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1846 2ec1f75b 2019-03-26 stsp .It Fl f
1847 d64cc78a 2022-01-25 thomas Perform the operation even if a file contains local modifications,
1848 d64cc78a 2022-01-25 thomas and do not raise an error if a specified
1849 d64cc78a 2022-01-25 thomas .Ar path
1850 d64cc78a 2022-01-25 thomas does not exist on disk.
1851 70e3e7f5 2019-12-13 tracey .It Fl k
1852 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1853 f2a9dc41 2019-12-13 tracey .It Fl R
1854 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1855 f2a9dc41 2019-12-13 tracey If this option is not specified,
1856 f2a9dc41 2019-12-13 tracey .Cm got remove
1857 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1858 f2a9dc41 2019-12-13 tracey .Ar path
1859 f2a9dc41 2019-12-13 tracey is a directory.
1860 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1861 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1862 766841c2 2020-08-13 stsp single-character status codes contained in the
1863 766841c2 2020-08-13 stsp .Ar status-codes
1864 766841c2 2020-08-13 stsp argument.
1865 766841c2 2020-08-13 stsp The following status codes may be specified:
1866 766841c2 2020-08-13 stsp .Bl -column YXZ description
1867 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1868 766841c2 2020-08-13 stsp .Fl f
1869 766841c2 2020-08-13 stsp option)
1870 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1871 766841c2 2020-08-13 stsp .El
1872 d0eebce4 2019-03-11 stsp .El
1873 069bbb86 2022-03-07 thomas .Tg pa
1874 56c96eff 2022-08-30 thomas .It Xo
1875 56c96eff 2022-08-30 thomas .Cm patch
1876 56c96eff 2022-08-30 thomas .Op Fl nR
1877 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1878 56c96eff 2022-08-30 thomas .Op Fl p Ar strip-count
1879 56c96eff 2022-08-30 thomas .Op Ar patchfile
1880 56c96eff 2022-08-30 thomas .Xc
1881 069bbb86 2022-03-07 thomas .Dl Pq alias: Cm pa
1882 069bbb86 2022-03-07 thomas Apply changes from
1883 069bbb86 2022-03-07 thomas .Ar patchfile
1884 07f74738 2022-03-13 thomas to files in a work tree.
1885 443c08c9 2022-03-13 thomas Files added or removed by a patch will be scheduled for addition or removal in
1886 443c08c9 2022-03-13 thomas the work tree.
1887 07f74738 2022-03-13 thomas .Pp
1888 07f74738 2022-03-13 thomas The patch must be in the unified diff format as produced by
1889 07f74738 2022-03-13 thomas .Cm got diff ,
1890 99e34129 2022-03-22 thomas .Xr git-diff 1 ,
1891 4929098b 2022-03-13 thomas or by
1892 07f74738 2022-03-13 thomas .Xr diff 1
1893 3eb4f629 2022-03-22 thomas and
1894 3eb4f629 2022-03-22 thomas .Xr cvs 1
1895 6f7394ad 2022-03-22 thomas diff when invoked with their
1896 07f74738 2022-03-13 thomas .Fl u
1897 6f7394ad 2022-03-22 thomas options.
1898 07f74738 2022-03-13 thomas If no
1899 069bbb86 2022-03-07 thomas .Ar patchfile
1900 07f74738 2022-03-13 thomas argument is provided, read unified diff data from standard input instead.
1901 07f74738 2022-03-13 thomas .Pp
1902 07f74738 2022-03-13 thomas If the
1903 07f74738 2022-03-13 thomas .Ar patchfile
1904 4b06140e 2022-03-22 thomas contains multiple patches, then attempt to apply each of them in sequence.
1905 069bbb86 2022-03-07 thomas .Pp
1906 4929098b 2022-03-13 thomas Show the status of each affected file, using the following status codes:
1907 069bbb86 2022-03-07 thomas .Bl -column XYZ description
1908 07f74738 2022-03-13 thomas .It M Ta file was modified
1909 762b8e82 2022-06-23 thomas .It G Ta file was merged using a merge-base found in the repository
1910 762b8e82 2022-06-23 thomas .It C Ta file was merged and conflicts occurred during merge
1911 07f74738 2022-03-13 thomas .It D Ta file was deleted
1912 07f74738 2022-03-13 thomas .It A Ta file was added
1913 49114f01 2022-03-22 thomas .It # Ta failed to patch the file
1914 069bbb86 2022-03-07 thomas .El
1915 069bbb86 2022-03-07 thomas .Pp
1916 07f74738 2022-03-13 thomas If a change does not match at its exact line number, attempt to
1917 4929098b 2022-03-13 thomas apply it somewhere else in the file if a good spot can be found.
1918 4929098b 2022-03-13 thomas Otherwise, the patch will fail to apply.
1919 2cfc25ac 2022-03-13 thomas .Pp
1920 2cfc25ac 2022-03-13 thomas .Nm
1921 2cfc25ac 2022-03-13 thomas .Cm patch
1922 2cfc25ac 2022-03-13 thomas will refuse to apply a patch if certain preconditions are not met.
1923 4929098b 2022-03-13 thomas Files to be deleted must already be under version control, and must
1924 4929098b 2022-03-13 thomas not have been scheduled for deletion already.
1925 4929098b 2022-03-13 thomas Files to be added must not yet be under version control and must not
1926 4929098b 2022-03-13 thomas already be present on disk.
1927 4929098b 2022-03-13 thomas Files to be modified must already be under version control and may not
1928 4929098b 2022-03-13 thomas contain conflict markers.
1929 2cfc25ac 2022-03-13 thomas .Pp
1930 2cfc25ac 2022-03-13 thomas If an error occurs, the
1931 2cfc25ac 2022-03-13 thomas .Cm patch
1932 2cfc25ac 2022-03-13 thomas operation will be aborted.
1933 2cfc25ac 2022-03-13 thomas Any changes made to the work tree up to this point will be left behind.
1934 07f74738 2022-03-13 thomas Such changes can be viewed with
1935 2cfc25ac 2022-03-13 thomas .Cm got diff
1936 2cfc25ac 2022-03-13 thomas and can be reverted with
1937 2cfc25ac 2022-03-13 thomas .Cm got revert
1938 2cfc25ac 2022-03-13 thomas if needed.
1939 bfc91212 2022-03-13 thomas .Pp
1940 bfc91212 2022-03-13 thomas The options for
1941 bfc91212 2022-03-13 thomas .Cm got patch
1942 bfc91212 2022-03-13 thomas are as follows:
1943 bfc91212 2022-03-13 thomas .Bl -tag -width Ds
1944 7d8bcb99 2022-07-28 thomas .It Fl c Ar commit
1945 82a8b7ec 2022-08-06 thomas Attempt to locate files within the specified
1946 7d8bcb99 2022-07-28 thomas .Ar commit
1947 82a8b7ec 2022-08-06 thomas for use as a merge-base for 3-way merges.
1948 482b0b83 2023-07-19 thomas .Pp
1949 482b0b83 2023-07-19 thomas If the
1950 482b0b83 2023-07-19 thomas .Fl c
1951 482b0b83 2023-07-19 thomas option is not used then
1952 482b0b83 2023-07-19 thomas .Cm got patch
1953 482b0b83 2023-07-19 thomas will attempt to locate merge-bases via object IDs found in
1954 482b0b83 2023-07-19 thomas .Ar patchfile
1955 482b0b83 2023-07-19 thomas meta-data, such as produced by
1956 482b0b83 2023-07-19 thomas .Cm got diff
1957 482b0b83 2023-07-19 thomas or
1958 482b0b83 2023-07-19 thomas .Xr git-diff 1 .
1959 482b0b83 2023-07-19 thomas Use of the
1960 482b0b83 2023-07-19 thomas .Fl c
1961 482b0b83 2023-07-19 thomas option is only recommended in the absence of such meta-data.
1962 482b0b83 2023-07-19 thomas .Pp
1963 482b0b83 2023-07-19 thomas Ideally, the specified
1964 482b0b83 2023-07-19 thomas .Ar commit
1965 482b0b83 2023-07-19 thomas should contain versions of files which the changes contained in the
1966 482b0b83 2023-07-19 thomas .Ar patchfile
1967 482b0b83 2023-07-19 thomas were based on.
1968 482b0b83 2023-07-19 thomas Files will be located by path, relative to the repository root.
1969 482b0b83 2023-07-19 thomas If the
1970 482b0b83 2023-07-19 thomas .Fl p
1971 482b0b83 2023-07-19 thomas option is used then leading path components will be stripped
1972 482b0b83 2023-07-19 thomas before paths are looked up in the repository.
1973 482b0b83 2023-07-19 thomas .Pp
1974 482b0b83 2023-07-19 thomas In case no merge-base is available for a file, changes will be applied
1975 482b0b83 2023-07-19 thomas without doing a 3-way merge.
1976 482b0b83 2023-07-19 thomas Changes which do not apply cleanly may then be rejected entirely, rather
1977 482b0b83 2023-07-19 thomas than producing merge conflicts in the patched target file.
1978 482b0b83 2023-07-19 thomas .Pp
1979 fb885120 2023-07-19 thomas The expected
1980 fb885120 2023-07-19 thomas .Ar commit
1981 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
1982 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
1983 fb885120 2023-07-19 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
1984 fb885120 2023-07-19 thomas automatically, provided the abbreviation is unique.
1985 a290e4b4 2023-07-19 thomas The keywords
1986 fb885120 2023-07-19 thomas .Qq :base
1987 fb885120 2023-07-19 thomas and
1988 fb885120 2023-07-19 thomas .Qq :head
1989 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1990 fb885120 2023-07-19 thomas Keywords and references may be appended with
1991 fb885120 2023-07-19 thomas .Qq :+
1992 fb885120 2023-07-19 thomas or
1993 fb885120 2023-07-19 thomas .Qq :-
1994 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
1995 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1996 fb885120 2023-07-19 thomas for example,
1997 fb885120 2023-07-19 thomas .Sy :head:-2
1998 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1999 fb885120 2023-07-19 thomas .Sy :base:+4
2000 fb885120 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
2001 fb885120 2023-07-19 thomas Similarly,
2002 fb885120 2023-07-19 thomas .Sy flan:+3
2003 fb885120 2023-07-19 thomas will denote the 3rd generation descendant of the commit resolved by the
2004 fb885120 2023-07-19 thomas .Qq flan
2005 fb885120 2023-07-19 thomas reference.
2006 fb885120 2023-07-19 thomas A
2007 fb885120 2023-07-19 thomas .Qq :+
2008 fb885120 2023-07-19 thomas or
2009 fb885120 2023-07-19 thomas .Qq :-
2010 fb885120 2023-07-19 thomas modifier without a trailing integer has an implicit
2011 fb885120 2023-07-19 thomas .Qq 1
2012 fb885120 2023-07-19 thomas appended
2013 fb885120 2023-07-19 thomas .Po e.g.,
2014 fb885120 2023-07-19 thomas .Sy :base:+
2015 fb885120 2023-07-19 thomas is equivalent to
2016 fb885120 2023-07-19 thomas .Sy :base:+1
2017 fb885120 2023-07-19 thomas .Pc .
2018 bfc91212 2022-03-13 thomas .It Fl n
2019 bfc91212 2022-03-13 thomas Do not make any modifications to the work tree.
2020 bfc91212 2022-03-13 thomas This can be used to check whether a patch would apply without issues.
2021 bfc91212 2022-03-13 thomas If the
2022 bfc91212 2022-03-13 thomas .Ar patchfile
2023 4b06140e 2022-03-22 thomas contains diffs that affect the same file multiple times, the results
2024 bfc91212 2022-03-13 thomas displayed may be incorrect.
2025 d9db2ff9 2022-04-16 thomas .It Fl p Ar strip-count
2026 d9db2ff9 2022-04-16 thomas Specify the number of leading path components to strip from paths
2027 d9db2ff9 2022-04-16 thomas parsed from
2028 d9db2ff9 2022-04-16 thomas .Ar patchfile .
2029 d9db2ff9 2022-04-16 thomas If the
2030 d9db2ff9 2022-04-16 thomas .Fl p
2031 d9db2ff9 2022-04-16 thomas option is not used,
2032 d9db2ff9 2022-04-16 thomas .Sq a/
2033 d9db2ff9 2022-04-16 thomas and
2034 d9db2ff9 2022-04-16 thomas .Sq b/
2035 d9db2ff9 2022-04-16 thomas path prefixes generated by
2036 d9db2ff9 2022-04-16 thomas .Xr git-diff 1
2037 d9db2ff9 2022-04-16 thomas will be recognized and stripped automatically.
2038 eaef698f 2022-04-23 thomas .It Fl R
2039 eaef698f 2022-04-23 thomas Reverse the patch before applying it.
2040 bfc91212 2022-03-13 thomas .El
2041 e8aa341a 2021-10-08 thomas .Tg rv
2042 56c96eff 2022-08-30 thomas .It Xo
2043 56c96eff 2022-08-30 thomas .Cm revert
2044 56c96eff 2022-08-30 thomas .Op Fl pR
2045 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
2046 56c96eff 2022-08-30 thomas .Ar path ...
2047 56c96eff 2022-08-30 thomas .Xc
2048 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rv
2049 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
2050 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
2051 1dd86744 2019-08-12 anthony work tree's base commit.
2052 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
2053 a129376b 2019-03-28 stsp .Cm got revert !
2054 a129376b 2019-03-28 stsp .Pp
2055 e20a8b6f 2019-06-04 stsp If a file was added with
2056 4b06140e 2022-03-22 thomas .Cm got add ,
2057 a129376b 2019-03-28 stsp it will become an unversioned file again.
2058 e20a8b6f 2019-06-04 stsp If a file was deleted with
2059 4b06140e 2022-03-22 thomas .Cm got remove ,
2060 a129376b 2019-03-28 stsp it will be restored.
2061 0f6d7415 2019-08-08 stsp .Pp
2062 0f6d7415 2019-08-08 stsp The options for
2063 0f6d7415 2019-08-08 stsp .Cm got revert
2064 0f6d7415 2019-08-08 stsp are as follows:
2065 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
2066 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
2067 d6506a3d 2022-08-16 thomas With the
2068 d6506a3d 2022-08-16 thomas .Fl p
2069 d6506a3d 2022-08-16 thomas option, read
2070 d6506a3d 2022-08-16 thomas .Dq y ,
2071 d6506a3d 2022-08-16 thomas .Dq n ,
2072 d6506a3d 2022-08-16 thomas and
2073 d6506a3d 2022-08-16 thomas .Dq q
2074 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
2075 d6506a3d 2022-08-16 thomas .Ar response-script
2076 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
2077 33aa809d 2019-08-08 stsp .It Fl p
2078 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
2079 33aa809d 2019-08-08 stsp changes to revert based on
2080 33aa809d 2019-08-08 stsp .Dq y
2081 33aa809d 2019-08-08 stsp (revert change),
2082 33aa809d 2019-08-08 stsp .Dq n
2083 33aa809d 2019-08-08 stsp (keep change), and
2084 33aa809d 2019-08-08 stsp .Dq q
2085 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
2086 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
2087 33aa809d 2019-08-08 stsp modified file content can be reverted.
2088 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
2089 0f6d7415 2019-08-08 stsp .It Fl R
2090 0f6d7415 2019-08-08 stsp Permit recursion into directories.
2091 0f6d7415 2019-08-08 stsp If this option is not specified,
2092 0f6d7415 2019-08-08 stsp .Cm got revert
2093 0f6d7415 2019-08-08 stsp will refuse to run if a specified
2094 0f6d7415 2019-08-08 stsp .Ar path
2095 0f6d7415 2019-08-08 stsp is a directory.
2096 0f6d7415 2019-08-08 stsp .El
2097 e8aa341a 2021-10-08 thomas .Tg ci
2098 56c96eff 2022-08-30 thomas .It Xo
2099 56c96eff 2022-08-30 thomas .Cm commit
2100 be94c032 2023-02-20 thomas .Op Fl CNnS
2101 56c96eff 2022-08-30 thomas .Op Fl A Ar author
2102 56c96eff 2022-08-30 thomas .Op Fl F Ar path
2103 56c96eff 2022-08-30 thomas .Op Fl m Ar message
2104 56c96eff 2022-08-30 thomas .Op Ar path ...
2105 56c96eff 2022-08-30 thomas .Xc
2106 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ci
2107 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
2108 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
2109 5c1e53bc 2019-07-28 stsp If no
2110 90e8619e 2019-07-25 stsp .Ar path
2111 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
2112 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
2113 15cd91f7 2019-05-12 stsp .Pp
2114 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
2115 1dd86744 2019-08-12 anthony .Cm got stage ,
2116 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
2117 4ed9f614 2019-08-04 stsp have not been staged.
2118 4ed9f614 2019-08-04 stsp .Pp
2119 28cf319f 2021-01-28 stsp .Cm got commit
2120 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
2121 28cf319f 2021-01-28 stsp unless the
2122 28cf319f 2021-01-28 stsp .Fl m
2123 28cf319f 2021-01-28 stsp option is used
2124 28cf319f 2021-01-28 stsp or the
2125 28cf319f 2021-01-28 stsp .Fl F
2126 28cf319f 2021-01-28 stsp and
2127 28cf319f 2021-01-28 stsp .Fl N
2128 28cf319f 2021-01-28 stsp options are used together.
2129 bccae03f 2023-07-17 thomas Quitting the editor without saving the file will abort the commit operation.
2130 28cf319f 2021-01-28 stsp .Pp
2131 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
2132 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
2133 15cd91f7 2019-05-12 stsp .It M Ta modified file
2134 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
2135 15cd91f7 2019-05-12 stsp .It A Ta new file was added
2136 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
2137 15cd91f7 2019-05-12 stsp .El
2138 15cd91f7 2019-05-12 stsp .Pp
2139 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
2140 996d5ccd 2019-08-05 stsp recorded base commit.
2141 15cd91f7 2019-05-12 stsp Some
2142 15cd91f7 2019-05-12 stsp .Nm
2143 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
2144 15cd91f7 2019-05-12 stsp multiple base commits.
2145 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
2146 47ec7be7 2019-05-12 stsp .Cm got update
2147 47ec7be7 2019-05-12 stsp across the entire work tree.
2148 15cd91f7 2019-05-12 stsp .Pp
2149 15cd91f7 2019-05-12 stsp The
2150 15cd91f7 2019-05-12 stsp .Cm got commit
2151 15cd91f7 2019-05-12 stsp command requires the
2152 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
2153 aba9c984 2019-09-08 stsp environment variable to be set,
2154 257add31 2020-09-09 stsp unless an author has been configured in
2155 257add31 2020-09-09 stsp .Xr got.conf 5
2156 257add31 2020-09-09 stsp or Git's
2157 aba9c984 2019-09-08 stsp .Dv user.name
2158 aba9c984 2019-09-08 stsp and
2159 709ae9eb 2019-09-08 stsp .Dv user.email
2160 709ae9eb 2019-09-08 stsp configuration settings can be
2161 aba9c984 2019-09-08 stsp obtained from the repository's
2162 aba9c984 2019-09-08 stsp .Pa .git/config
2163 c9956ddf 2019-09-08 stsp file or from Git's global
2164 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
2165 c9956ddf 2019-09-08 stsp configuration file.
2166 74416c47 2019-05-09 stsp .Pp
2167 74416c47 2019-05-09 stsp The options for
2168 74416c47 2019-05-09 stsp .Cm got commit
2169 74416c47 2019-05-09 stsp are as follows:
2170 74416c47 2019-05-09 stsp .Bl -tag -width Ds
2171 18d1acad 2022-07-20 thomas .It Fl A Ar author
2172 18d1acad 2022-07-20 thomas Set author information in the newly created commit to
2173 18d1acad 2022-07-20 thomas .Ar author .
2174 fbbd3dd5 2023-02-17 thomas This is useful when committing changes on behalf of someone else.
2175 18d1acad 2022-07-20 thomas The
2176 18d1acad 2022-07-20 thomas .Ar author
2177 18d1acad 2022-07-20 thomas argument must use the same format as the
2178 18d1acad 2022-07-20 thomas .Ev GOT_AUTHOR
2179 18d1acad 2022-07-20 thomas environment variable.
2180 18d1acad 2022-07-20 thomas .Pp
2181 18d1acad 2022-07-20 thomas In addition to storing author information, the newly created commit
2182 18d1acad 2022-07-20 thomas object will retain
2183 18d1acad 2022-07-20 thomas .Dq committer
2184 18d1acad 2022-07-20 thomas information which is obtained, as usual, from the
2185 18d1acad 2022-07-20 thomas .Ev GOT_AUTHOR
2186 18d1acad 2022-07-20 thomas environment variable, or
2187 18d1acad 2022-07-20 thomas .Xr got.conf 5 ,
2188 18d1acad 2022-07-20 thomas or Git configuration settings.
2189 be94c032 2023-02-20 thomas .It Fl C
2190 be94c032 2023-02-20 thomas Allow committing files in conflicted status.
2191 be94c032 2023-02-20 thomas .Pp
2192 be94c032 2023-02-20 thomas Committing files with conflict markers should generally be avoided.
2193 be94c032 2023-02-20 thomas Cases where conflict markers must be stored in the repository for
2194 be94c032 2023-02-20 thomas some legitimate reason should be very rare.
2195 be94c032 2023-02-20 thomas There are usually ways to avoid storing conflict markers verbatim by
2196 be94c032 2023-02-20 thomas applying appropriate programming tricks.
2197 28cf319f 2021-01-28 stsp .It Fl F Ar path
2198 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
2199 28cf319f 2021-01-28 stsp .Ar path
2200 28cf319f 2021-01-28 stsp when creating the new commit.
2201 28cf319f 2021-01-28 stsp .Cm got commit
2202 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
2203 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
2204 28cf319f 2021-01-28 stsp Cannot be used together with the
2205 23594da9 2019-05-13 stsp .Fl m
2206 28cf319f 2021-01-28 stsp option.
2207 28cf319f 2021-01-28 stsp .It Fl m Ar message
2208 28cf319f 2021-01-28 stsp Use the specified log message when creating the new commit.
2209 28cf319f 2021-01-28 stsp Cannot be used together with the
2210 28cf319f 2021-01-28 stsp .Fl F
2211 28cf319f 2021-01-28 stsp option.
2212 28cf319f 2021-01-28 stsp .It Fl N
2213 28cf319f 2021-01-28 stsp This option prevents
2214 23594da9 2019-05-13 stsp .Cm got commit
2215 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
2216 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
2217 28cf319f 2021-01-28 stsp .Fl F
2218 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
2219 ef899790 2022-11-01 thomas .It Fl n
2220 ef899790 2022-11-01 thomas This option prevents
2221 ef899790 2022-11-01 thomas .Cm got commit
2222 ef899790 2022-11-01 thomas from generating a diff of the to-be-committed changes in a temporary file
2223 ef899790 2022-11-01 thomas which can be viewed while editing a commit message.
2224 35213c7c 2020-07-23 stsp .It Fl S
2225 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
2226 af358f55 2020-07-23 stsp that is under version control.
2227 af358f55 2020-07-23 stsp By default,
2228 af358f55 2020-07-23 stsp .Cm got commit
2229 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
2230 35213c7c 2020-07-23 stsp As a precaution,
2231 35213c7c 2020-07-23 stsp .Nm
2232 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
2233 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
2234 af358f55 2020-07-23 stsp points outside of the work tree.
2235 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
2236 af358f55 2020-07-23 stsp .Dq make obj
2237 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
2238 af358f55 2020-07-23 stsp version control.
2239 2ec1f75b 2019-03-26 stsp .El
2240 cfce0458 2019-07-28 stsp .Pp
2241 cfce0458 2019-07-28 stsp .Cm got commit
2242 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
2243 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
2244 916f288c 2019-07-30 stsp .Dq refs/heads/
2245 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
2246 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
2247 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
2248 cfce0458 2019-07-28 stsp If a path is found to be out of date,
2249 cfce0458 2019-07-28 stsp .Cm got update
2250 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
2251 cfce0458 2019-07-28 stsp in the repository.
2252 e8aa341a 2021-10-08 thomas .Tg se
2253 56c96eff 2022-08-30 thomas .It Xo
2254 56c96eff 2022-08-30 thomas .Cm send
2255 56c96eff 2022-08-30 thomas .Op Fl afqTv
2256 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
2257 56c96eff 2022-08-30 thomas .Op Fl d Ar branch
2258 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
2259 56c96eff 2022-08-30 thomas .Op Fl t Ar tag
2260 56c96eff 2022-08-30 thomas .Op Ar remote-repository
2261 56c96eff 2022-08-30 thomas .Xc
2262 d912d125 2021-11-04 thomas .Dl Pq alias: Cm se
2263 f8a36e22 2021-08-26 stsp Send new changes to a remote repository.
2264 f8a36e22 2021-08-26 stsp If no
2265 f8a36e22 2021-08-26 stsp .Ar remote-repository
2266 f8a36e22 2021-08-26 stsp is specified,
2267 f8a36e22 2021-08-26 stsp .Dq origin
2268 f8a36e22 2021-08-26 stsp will be used.
2269 f8a36e22 2021-08-26 stsp The remote repository's URL is obtained from the corresponding entry in
2270 f8a36e22 2021-08-26 stsp .Xr got.conf 5
2271 f8a36e22 2021-08-26 stsp or Git's
2272 f8a36e22 2021-08-26 stsp .Pa config
2273 f8a36e22 2021-08-26 stsp file of the local repository, as created by
2274 f8a36e22 2021-08-26 stsp .Cm got clone .
2275 f8a36e22 2021-08-26 stsp .Pp
2276 f8a36e22 2021-08-26 stsp All objects corresponding to new changes will be written to a temporary
2277 f8a36e22 2021-08-26 stsp pack file which is then uploaded to the server.
2278 f8a36e22 2021-08-26 stsp Upon success, references in the
2279 f8a36e22 2021-08-26 stsp .Dq refs/remotes/
2280 f8a36e22 2021-08-26 stsp reference namespace of the local repository will be updated to point at
2281 f8a36e22 2021-08-26 stsp the commits which have been sent.
2282 f8a36e22 2021-08-26 stsp .Pp
2283 f8a36e22 2021-08-26 stsp By default, changes will only be sent if they are based on up-to-date
2284 f8a36e22 2021-08-26 stsp copies of relevant branches in the remote repository.
2285 fd44090b 2021-08-26 stsp If any changes to be sent are based on out-of-date copies or would
2286 fd44090b 2021-08-26 stsp otherwise break linear history of existing branches, new changes must
2287 fd44090b 2021-08-26 stsp be fetched from the server with
2288 f8a36e22 2021-08-26 stsp .Cm got fetch
2289 f8a36e22 2021-08-26 stsp and local branches must be rebased with
2290 f8a36e22 2021-08-26 stsp .Cm got rebase
2291 f8a36e22 2021-08-26 stsp before
2292 f8a36e22 2021-08-26 stsp .Cm got send
2293 f8a36e22 2021-08-26 stsp can succeed.
2294 fd44090b 2021-08-26 stsp The
2295 fd44090b 2021-08-26 stsp .Fl f
2296 fd44090b 2021-08-26 stsp option can be used to make exceptions to these requirements.
2297 f8a36e22 2021-08-26 stsp .Pp
2298 f8a36e22 2021-08-26 stsp The options for
2299 f8a36e22 2021-08-26 stsp .Cm got send
2300 f8a36e22 2021-08-26 stsp are as follows:
2301 f8a36e22 2021-08-26 stsp .Bl -tag -width Ds
2302 f8a36e22 2021-08-26 stsp .It Fl a
2303 f8a36e22 2021-08-26 stsp Send all branches from the local repository's
2304 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2305 f8a36e22 2021-08-26 stsp reference namespace.
2306 f8a36e22 2021-08-26 stsp The
2307 f8a36e22 2021-08-26 stsp .Fl a
2308 f8a36e22 2021-08-26 stsp option is equivalent to listing all branches with multiple
2309 f8a36e22 2021-08-26 stsp .Fl b
2310 f8a36e22 2021-08-26 stsp options.
2311 f8a36e22 2021-08-26 stsp Cannot be used together with the
2312 f8a36e22 2021-08-26 stsp .Fl b
2313 f8a36e22 2021-08-26 stsp option.
2314 f8a36e22 2021-08-26 stsp .It Fl b Ar branch
2315 f8a36e22 2021-08-26 stsp Send the specified
2316 f8a36e22 2021-08-26 stsp .Ar branch
2317 f8a36e22 2021-08-26 stsp from the local repository's
2318 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2319 f8a36e22 2021-08-26 stsp reference namespace.
2320 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
2321 f8a36e22 2021-08-26 stsp to send.
2322 f8a36e22 2021-08-26 stsp If this option is not specified, default to the work tree's current branch
2323 f8a36e22 2021-08-26 stsp if invoked in a work tree, or to the repository's HEAD reference.
2324 f8a36e22 2021-08-26 stsp Cannot be used together with the
2325 f8a36e22 2021-08-26 stsp .Fl a
2326 f8a36e22 2021-08-26 stsp option.
2327 f8a36e22 2021-08-26 stsp .It Fl d Ar branch
2328 f8a36e22 2021-08-26 stsp Delete the specified
2329 f8a36e22 2021-08-26 stsp .Ar branch
2330 f8a36e22 2021-08-26 stsp from the remote repository's
2331 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2332 f8a36e22 2021-08-26 stsp reference namespace.
2333 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
2334 f8a36e22 2021-08-26 stsp to delete.
2335 f8a36e22 2021-08-26 stsp .Pp
2336 f8a36e22 2021-08-26 stsp Only references are deleted.
2337 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to deleted branches
2338 f8a36e22 2021-08-26 stsp may become subject to deletion by Git's garbage collector running on
2339 f8a36e22 2021-08-26 stsp the server.
2340 f8a36e22 2021-08-26 stsp .Pp
2341 f8a36e22 2021-08-26 stsp Requesting deletion of branches results in an error if the server
2342 fd44090b 2021-08-26 stsp does not support this feature or disallows the deletion of branches
2343 fd44090b 2021-08-26 stsp based on its configuration.
2344 f8a36e22 2021-08-26 stsp .It Fl f
2345 fd44090b 2021-08-26 stsp Attempt to force the server to overwrite existing branches or tags
2346 fd44090b 2021-08-26 stsp in the remote repository, even when
2347 fd44090b 2021-08-26 stsp .Cm got fetch
2348 1a70a207 2023-07-05 thomas followed by
2349 fd44090b 2021-08-26 stsp .Cm got rebase
2350 1a70a207 2023-07-05 thomas or
2351 1a70a207 2023-07-05 thomas .Cm got merge
2352 fd44090b 2021-08-26 stsp would usually be required before changes can be sent.
2353 f8a36e22 2021-08-26 stsp The server may reject forced requests regardless, depending on its
2354 f8a36e22 2021-08-26 stsp configuration.
2355 f8a36e22 2021-08-26 stsp .Pp
2356 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to overwritten branches
2357 f8a36e22 2021-08-26 stsp or tags may become subject to deletion by Git's garbage collector running
2358 f8a36e22 2021-08-26 stsp on the server.
2359 f8a36e22 2021-08-26 stsp .Pp
2360 f8a36e22 2021-08-26 stsp The
2361 f8a36e22 2021-08-26 stsp .Dq refs/tags
2362 f8a36e22 2021-08-26 stsp reference namespace is globally shared between all repositories.
2363 f8a36e22 2021-08-26 stsp Use of the
2364 f8a36e22 2021-08-26 stsp .Fl f
2365 f8a36e22 2021-08-26 stsp option to overwrite tags is discouraged because it can lead to
2366 f8a36e22 2021-08-26 stsp inconsistencies between the tags present in different repositories.
2367 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
2368 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
2369 f8a36e22 2021-08-26 stsp .Pp
2370 f8a36e22 2021-08-26 stsp Use of the
2371 f8a36e22 2021-08-26 stsp .Fl f
2372 f8a36e22 2021-08-26 stsp option is particularly discouraged if changes being sent are based
2373 f8a36e22 2021-08-26 stsp on an out-of-date copy of a branch in the remote repository.
2374 f8a36e22 2021-08-26 stsp Instead of using the
2375 f8a36e22 2021-08-26 stsp .Fl f
2376 f8a36e22 2021-08-26 stsp option, new changes should
2377 f8a36e22 2021-08-26 stsp be fetched with
2378 f8a36e22 2021-08-26 stsp .Cm got fetch
2379 f8a36e22 2021-08-26 stsp and local branches should be rebased with
2380 1a70a207 2023-07-05 thomas .Cm got rebase
2381 1a70a207 2023-07-05 thomas or merged with
2382 1a70a207 2023-07-05 thomas .Cm got merge ,
2383 f8a36e22 2021-08-26 stsp followed by another attempt to send the changes.
2384 f8a36e22 2021-08-26 stsp .Pp
2385 f8a36e22 2021-08-26 stsp The
2386 f8a36e22 2021-08-26 stsp .Fl f
2387 f8a36e22 2021-08-26 stsp option should only be needed in situations where the remote repository's
2388 f8a36e22 2021-08-26 stsp copy of a branch or tag is known to be out-of-date and is considered
2389 f8a36e22 2021-08-26 stsp disposable.
2390 f8a36e22 2021-08-26 stsp The risks of creating inconsistencies between different repositories
2391 f8a36e22 2021-08-26 stsp should also be taken into account.
2392 d6506a3d 2022-08-16 thomas .It Fl q
2393 d6506a3d 2022-08-16 thomas Suppress progress reporting output.
2394 d6506a3d 2022-08-16 thomas The same option will be passed to
2395 d6506a3d 2022-08-16 thomas .Xr ssh 1
2396 d6506a3d 2022-08-16 thomas if applicable.
2397 f8a36e22 2021-08-26 stsp .It Fl r Ar repository-path
2398 f8a36e22 2021-08-26 stsp Use the repository at the specified path.
2399 f8a36e22 2021-08-26 stsp If not specified, assume the repository is located at or above the current
2400 f8a36e22 2021-08-26 stsp working directory.
2401 f8a36e22 2021-08-26 stsp If this directory is a
2402 f8a36e22 2021-08-26 stsp .Nm
2403 f8a36e22 2021-08-26 stsp work tree, use the repository path associated with this work tree.
2404 d6506a3d 2022-08-16 thomas .It Fl T
2405 d6506a3d 2022-08-16 thomas Attempt to send all tags from the local repository's
2406 d6506a3d 2022-08-16 thomas .Dq refs/tags/
2407 d6506a3d 2022-08-16 thomas reference namespace.
2408 d6506a3d 2022-08-16 thomas The
2409 d6506a3d 2022-08-16 thomas .Fl T
2410 d6506a3d 2022-08-16 thomas option is equivalent to listing all tags with multiple
2411 d6506a3d 2022-08-16 thomas .Fl t
2412 d6506a3d 2022-08-16 thomas options.
2413 d6506a3d 2022-08-16 thomas Cannot be used together with the
2414 d6506a3d 2022-08-16 thomas .Fl t
2415 d6506a3d 2022-08-16 thomas option.
2416 f8a36e22 2021-08-26 stsp .It Fl t Ar tag
2417 f8a36e22 2021-08-26 stsp Send the specified
2418 f8a36e22 2021-08-26 stsp .Ar tag
2419 f8a36e22 2021-08-26 stsp from the local repository's
2420 f8a36e22 2021-08-26 stsp .Dq refs/tags/
2421 f8a36e22 2021-08-26 stsp reference namespace, in addition to any branches that are being sent.
2422 f8a36e22 2021-08-26 stsp The
2423 f8a36e22 2021-08-26 stsp .Fl t
2424 f8a36e22 2021-08-26 stsp option may be specified multiple times to build a list of tags to send.
2425 f8a36e22 2021-08-26 stsp No tags will be sent if the
2426 f8a36e22 2021-08-26 stsp .Fl t
2427 f8a36e22 2021-08-26 stsp option is not used.
2428 f8a36e22 2021-08-26 stsp .Pp
2429 f8a36e22 2021-08-26 stsp Raise an error if the specified
2430 f8a36e22 2021-08-26 stsp .Ar tag
2431 f8a36e22 2021-08-26 stsp already exists in the remote repository, unless the
2432 f8a36e22 2021-08-26 stsp .Fl f
2433 93a300b2 2021-08-26 stsp option is used to overwrite the server's copy of the tag.
2434 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
2435 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
2436 f8a36e22 2021-08-26 stsp .Pp
2437 f8a36e22 2021-08-26 stsp Cannot be used together with the
2438 f8a36e22 2021-08-26 stsp .Fl T
2439 f8a36e22 2021-08-26 stsp option.
2440 f8a36e22 2021-08-26 stsp .It Fl v
2441 f8a36e22 2021-08-26 stsp Verbose mode.
2442 f8a36e22 2021-08-26 stsp Causes
2443 f8a36e22 2021-08-26 stsp .Cm got send
2444 f8a36e22 2021-08-26 stsp to print debugging messages to standard error output.
2445 f8a36e22 2021-08-26 stsp The same option will be passed to
2446 f8a36e22 2021-08-26 stsp .Xr ssh 1
2447 f8a36e22 2021-08-26 stsp if applicable.
2448 f8a36e22 2021-08-26 stsp Multiple -v options increase the verbosity.
2449 f8a36e22 2021-08-26 stsp The maximum is 3.
2450 f8a36e22 2021-08-26 stsp .El
2451 e8aa341a 2021-10-08 thomas .Tg cy
2452 f6cd0243 2023-01-28 thomas .It Xo
2453 f6cd0243 2023-01-28 thomas .Cm cherrypick
2454 f6cd0243 2023-01-28 thomas .Op Fl lX
2455 7e710171 2023-01-28 thomas .Op Ar commit
2456 f6cd0243 2023-01-28 thomas .Xc
2457 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cy
2458 234035bc 2019-06-01 stsp Merge changes from a single
2459 234035bc 2019-06-01 stsp .Ar commit
2460 234035bc 2019-06-01 stsp into the work tree.
2461 234035bc 2019-06-01 stsp The specified
2462 234035bc 2019-06-01 stsp .Ar commit
2463 a16d97bd 2021-09-02 stsp should be on a different branch than the work tree's base commit.
2464 a290e4b4 2023-07-19 thomas .Pp
2465 a290e4b4 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name or
2466 a290e4b4 2023-07-19 thomas keyword which will be resolved to a commit ID.
2467 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2468 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2469 a290e4b4 2023-07-19 thomas The keywords
2470 fb885120 2023-07-19 thomas .Qq :base
2471 fb885120 2023-07-19 thomas and
2472 fb885120 2023-07-19 thomas .Qq :head
2473 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
2474 fb885120 2023-07-19 thomas Keywords and references may be appended with
2475 fb885120 2023-07-19 thomas .Qq :+
2476 fb885120 2023-07-19 thomas or
2477 fb885120 2023-07-19 thomas .Qq :-
2478 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
2479 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
2480 fb885120 2023-07-19 thomas for example,
2481 fb885120 2023-07-19 thomas .Sy :head:-2
2482 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
2483 fb885120 2023-07-19 thomas .Sy :base:+4
2484 fb885120 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
2485 fb885120 2023-07-19 thomas Similarly,
2486 fb885120 2023-07-19 thomas .Sy barbaz:+3
2487 fb885120 2023-07-19 thomas will denote the 3rd generation descendant of the commit resolved by the
2488 fb885120 2023-07-19 thomas .Qq barbaz
2489 fb885120 2023-07-19 thomas reference.
2490 fb885120 2023-07-19 thomas A
2491 fb885120 2023-07-19 thomas .Qq :+
2492 fb885120 2023-07-19 thomas or
2493 fb885120 2023-07-19 thomas .Qq :-
2494 fb885120 2023-07-19 thomas modifier without a trailing integer has an implicit
2495 fb885120 2023-07-19 thomas .Qq 1
2496 fb885120 2023-07-19 thomas appended
2497 fb885120 2023-07-19 thomas .Po e.g.,
2498 fb885120 2023-07-19 thomas .Sy :base:+
2499 fb885120 2023-07-19 thomas is equivalent to
2500 fb885120 2023-07-19 thomas .Sy :base:+1
2501 fb885120 2023-07-19 thomas .Pc .
2502 234035bc 2019-06-01 stsp .Pp
2503 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
2504 234035bc 2019-06-01 stsp .Bl -column YXZ description
2505 234035bc 2019-06-01 stsp .It G Ta file was merged
2506 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
2507 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
2508 234035bc 2019-06-01 stsp .It D Ta file was deleted
2509 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2510 234035bc 2019-06-01 stsp .It A Ta new file was added
2511 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2512 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2513 74416c47 2019-05-09 stsp .El
2514 234035bc 2019-06-01 stsp .Pp
2515 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
2516 234035bc 2019-06-01 stsp may be viewed with
2517 234035bc 2019-06-01 stsp .Cm got diff ,
2518 234035bc 2019-06-01 stsp amended manually or with further
2519 234035bc 2019-06-01 stsp .Cm got cherrypick
2520 bc3056e3 2019-08-18 stsp commands,
2521 234035bc 2019-06-01 stsp committed with
2522 52d3950d 2023-01-28 thomas .Cm got commit .
2523 52d3950d 2023-01-28 thomas .Pp
2524 52d3950d 2023-01-28 thomas If invoked in a work tree where no
2525 52d3950d 2023-01-28 thomas .Cm rebase ,
2526 52d3950d 2023-01-28 thomas .Cm histedit ,
2527 52d3950d 2023-01-28 thomas or
2528 52d3950d 2023-01-28 thomas .Cm merge
2529 52d3950d 2023-01-28 thomas operation is taking place,
2530 52d3950d 2023-01-28 thomas .Cm got cherrypick
2531 52d3950d 2023-01-28 thomas creates a record of commits which have been merged into the work tree.
2532 52d3950d 2023-01-28 thomas When a file changed by
2533 52d3950d 2023-01-28 thomas .Cm got cherrypick
2534 52d3950d 2023-01-28 thomas is committed with
2535 52d3950d 2023-01-28 thomas .Cm got commit ,
2536 52d3950d 2023-01-28 thomas the log messages of relevant merged commits will then appear in the editor,
2537 75a8c854 2023-02-17 thomas where the messages should be further adjusted to convey the reasons for
2538 95e6f77e 2023-01-28 thomas cherrypicking the changes.
2539 83389425 2023-02-17 thomas Upon exiting the editor, if the time stamp of the log message file
2540 83389425 2023-02-17 thomas is unchanged or the log message is empty,
2541 75a8c854 2023-02-17 thomas .Cm got commit
2542 83389425 2023-02-17 thomas will fail with an unmodified or empty log message error.
2543 75a8c854 2023-02-17 thomas .Pp
2544 52d3950d 2023-01-28 thomas If all the changes in all files touched by a given commit are discarded,
2545 52d3950d 2023-01-28 thomas e.g. with
2546 52d3950d 2023-01-28 thomas .Cm got revert ,
2547 52d3950d 2023-01-28 thomas this commit's log message record will also disappear.
2548 234035bc 2019-06-01 stsp .Pp
2549 234035bc 2019-06-01 stsp .Cm got cherrypick
2550 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
2551 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2552 234035bc 2019-06-01 stsp to a single base commit with
2553 234035bc 2019-06-01 stsp .Cm got update .
2554 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2555 234035bc 2019-06-01 stsp conflicts must be resolved first.
2556 f6cd0243 2023-01-28 thomas .Pp
2557 f6cd0243 2023-01-28 thomas The options for
2558 f6cd0243 2023-01-28 thomas .Nm
2559 f6cd0243 2023-01-28 thomas .Cm cherrypick
2560 f6cd0243 2023-01-28 thomas are as follows:
2561 f6cd0243 2023-01-28 thomas .Bl -tag -width Ds
2562 f6cd0243 2023-01-28 thomas .It Fl l
2563 f6cd0243 2023-01-28 thomas Display a list of commit log messages recorded by cherrypick operations,
2564 f6cd0243 2023-01-28 thomas represented by references in the
2565 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2566 f6cd0243 2023-01-28 thomas reference namespace.
2567 f6cd0243 2023-01-28 thomas If a
2568 f6cd0243 2023-01-28 thomas .Ar commit
2569 f6cd0243 2023-01-28 thomas is specified, only show the log message of the specified commit.
2570 f6cd0243 2023-01-28 thomas .Pp
2571 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by cherrypick operations
2572 f6cd0243 2023-01-28 thomas in the current work tree will be displayed.
2573 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be displayed irrespective of the
2574 f6cd0243 2023-01-28 thomas work tree in which they were created.
2575 f6cd0243 2023-01-28 thomas This option cannot be used with
2576 52d3950d 2023-01-28 thomas .Fl X .
2577 f6cd0243 2023-01-28 thomas .It Fl X
2578 f6cd0243 2023-01-28 thomas Delete log messages created by previous cherrypick operations, represented by
2579 f6cd0243 2023-01-28 thomas references in the
2580 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2581 f6cd0243 2023-01-28 thomas reference namespace.
2582 f6cd0243 2023-01-28 thomas If a
2583 f6cd0243 2023-01-28 thomas .Ar commit
2584 f6cd0243 2023-01-28 thomas is specified, only delete the log message of the specified commit.
2585 f6cd0243 2023-01-28 thomas .Pp
2586 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by cherrypick operations
2587 f6cd0243 2023-01-28 thomas in the current work tree will be deleted.
2588 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be deleted irrespective of the
2589 f6cd0243 2023-01-28 thomas work tree in which they were created.
2590 f6cd0243 2023-01-28 thomas This option cannot be used with
2591 52d3950d 2023-01-28 thomas .Fl l .
2592 f6cd0243 2023-01-28 thomas .El
2593 f6cd0243 2023-01-28 thomas .Pp
2594 e8aa341a 2021-10-08 thomas .Tg bo
2595 f6cd0243 2023-01-28 thomas .It Xo
2596 f6cd0243 2023-01-28 thomas .Cm backout
2597 f6cd0243 2023-01-28 thomas .Op Fl lX
2598 7e710171 2023-01-28 thomas .Op Ar commit
2599 f6cd0243 2023-01-28 thomas .Xc
2600 d912d125 2021-11-04 thomas .Dl Pq alias: Cm bo
2601 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
2602 5ef14e63 2019-06-02 stsp .Ar commit
2603 5ef14e63 2019-06-02 stsp into the work tree.
2604 5ef14e63 2019-06-02 stsp The specified
2605 5ef14e63 2019-06-02 stsp .Ar commit
2606 a16d97bd 2021-09-02 stsp should be on the same branch as the work tree's base commit.
2607 a290e4b4 2023-07-19 thomas .Pp
2608 a290e4b4 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name
2609 a290e4b4 2023-07-19 thomas or keyword which will be resolved to a commit ID.
2610 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2611 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2612 a290e4b4 2023-07-19 thomas The keywords
2613 fb885120 2023-07-19 thomas .Qq :base
2614 fb885120 2023-07-19 thomas and
2615 fb885120 2023-07-19 thomas .Qq :head
2616 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
2617 fb885120 2023-07-19 thomas Keywords and references may be appended with
2618 fb885120 2023-07-19 thomas .Qq :+
2619 fb885120 2023-07-19 thomas or
2620 fb885120 2023-07-19 thomas .Qq :-
2621 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
2622 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
2623 fb885120 2023-07-19 thomas for example,
2624 fb885120 2023-07-19 thomas .Sy :head:-2
2625 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
2626 fb885120 2023-07-19 thomas .Sy :base:+4
2627 fb885120 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
2628 fb885120 2023-07-19 thomas Similarly,
2629 fb885120 2023-07-19 thomas .Sy wip:+5
2630 fb885120 2023-07-19 thomas will denote the 5th generation descendant of the commit resolved by the
2631 fb885120 2023-07-19 thomas .Qq wip
2632 fb885120 2023-07-19 thomas reference.
2633 fb885120 2023-07-19 thomas A
2634 fb885120 2023-07-19 thomas .Qq :+
2635 fb885120 2023-07-19 thomas or
2636 fb885120 2023-07-19 thomas .Qq :-
2637 fb885120 2023-07-19 thomas modifier without a trailing integer has an implicit
2638 fb885120 2023-07-19 thomas .Qq 1
2639 fb885120 2023-07-19 thomas appended
2640 fb885120 2023-07-19 thomas .Po e.g.,
2641 fb885120 2023-07-19 thomas .Sy :base:+
2642 fb885120 2023-07-19 thomas is equivalent to
2643 fb885120 2023-07-19 thomas .Sy :base:+1
2644 fb885120 2023-07-19 thomas .Pc .
2645 fb885120 2023-07-19 thomas .Pp
2646 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
2647 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
2648 5ef14e63 2019-06-02 stsp .It G Ta file was merged
2649 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
2650 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
2651 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
2652 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2653 5ef14e63 2019-06-02 stsp .It A Ta new file was added
2654 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2655 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2656 234035bc 2019-06-01 stsp .El
2657 5ef14e63 2019-06-02 stsp .Pp
2658 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
2659 5ef14e63 2019-06-02 stsp which may be viewed with
2660 5ef14e63 2019-06-02 stsp .Cm got diff ,
2661 5ef14e63 2019-06-02 stsp amended manually or with further
2662 778a73c2 2019-07-12 stsp .Cm got backout
2663 bc3056e3 2019-08-18 stsp commands,
2664 5ef14e63 2019-06-02 stsp committed with
2665 52d3950d 2023-01-28 thomas .Cm got commit .
2666 52d3950d 2023-01-28 thomas .Pp
2667 52d3950d 2023-01-28 thomas If invoked in a work tree where no
2668 52d3950d 2023-01-28 thomas .Cm rebase ,
2669 52d3950d 2023-01-28 thomas .Cm histedit ,
2670 52d3950d 2023-01-28 thomas or
2671 52d3950d 2023-01-28 thomas .Cm merge
2672 52d3950d 2023-01-28 thomas operation is taking place,
2673 52d3950d 2023-01-28 thomas .Cm got backout
2674 52d3950d 2023-01-28 thomas creates a record of commits which have been reverse-merged into the work tree.
2675 52d3950d 2023-01-28 thomas When a file changed by
2676 52d3950d 2023-01-28 thomas .Cm got backout
2677 52d3950d 2023-01-28 thomas is committed with
2678 52d3950d 2023-01-28 thomas .Cm got commit ,
2679 52d3950d 2023-01-28 thomas the log messages of relevant reverse-merged commits will then appear in
2680 75a8c854 2023-02-17 thomas the editor, where the messages should be further adjusted to convey the
2681 95e6f77e 2023-01-28 thomas reasons for backing out the changes.
2682 83389425 2023-02-17 thomas Upon exiting the editor, if the time stamp of the log message file
2683 83389425 2023-02-17 thomas is unchanged or the log message is empty,
2684 75a8c854 2023-02-17 thomas .Cm got commit
2685 83389425 2023-02-17 thomas will fail with an unmodified or empty log message error.
2686 75a8c854 2023-02-17 thomas .Pp
2687 52d3950d 2023-01-28 thomas If all the changes in all files touched by a given commit are discarded,
2688 52d3950d 2023-01-28 thomas e.g. with
2689 52d3950d 2023-01-28 thomas .Cm got revert ,
2690 52d3950d 2023-01-28 thomas this commit's log message record will also disappear.
2691 5ef14e63 2019-06-02 stsp .Pp
2692 92228c38 2019-06-02 stsp .Cm got backout
2693 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
2694 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2695 92228c38 2019-06-02 stsp to a single base commit with
2696 92228c38 2019-06-02 stsp .Cm got update .
2697 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2698 92228c38 2019-06-02 stsp conflicts must be resolved first.
2699 f6cd0243 2023-01-28 thomas .Pp
2700 f6cd0243 2023-01-28 thomas The options for
2701 f6cd0243 2023-01-28 thomas .Nm
2702 f6cd0243 2023-01-28 thomas .Cm backout
2703 f6cd0243 2023-01-28 thomas are as follows:
2704 f6cd0243 2023-01-28 thomas .Bl -tag -width Ds
2705 f6cd0243 2023-01-28 thomas .It Fl l
2706 f6cd0243 2023-01-28 thomas Display a list of commit log messages recorded by backout operations,
2707 f6cd0243 2023-01-28 thomas represented by references in the
2708 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2709 f6cd0243 2023-01-28 thomas reference namespace.
2710 f6cd0243 2023-01-28 thomas If a
2711 f6cd0243 2023-01-28 thomas .Ar commit
2712 f6cd0243 2023-01-28 thomas is specified, only show the log message of the specified commit.
2713 f6cd0243 2023-01-28 thomas .Pp
2714 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by backout operations
2715 f6cd0243 2023-01-28 thomas in the current work tree will be displayed.
2716 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be displayed irrespective of the
2717 f6cd0243 2023-01-28 thomas work tree in which they were created.
2718 f6cd0243 2023-01-28 thomas This option cannot be used with
2719 52d3950d 2023-01-28 thomas .Fl X .
2720 f6cd0243 2023-01-28 thomas .It Fl X
2721 f6cd0243 2023-01-28 thomas Delete log messages created by previous backout operations, represented by
2722 f6cd0243 2023-01-28 thomas references in the
2723 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2724 f6cd0243 2023-01-28 thomas reference namespace.
2725 f6cd0243 2023-01-28 thomas If a
2726 f6cd0243 2023-01-28 thomas .Ar commit
2727 f6cd0243 2023-01-28 thomas is specified, only delete the log message of the specified commit.
2728 f6cd0243 2023-01-28 thomas .Pp
2729 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by backout operations
2730 f6cd0243 2023-01-28 thomas in the current work tree will be deleted.
2731 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be deleted irrespective of the
2732 f6cd0243 2023-01-28 thomas work tree in which they were created.
2733 f6cd0243 2023-01-28 thomas This option cannot be used with
2734 52d3950d 2023-01-28 thomas .Fl l .
2735 f6cd0243 2023-01-28 thomas .El
2736 f6cd0243 2023-01-28 thomas .Pp
2737 e8aa341a 2021-10-08 thomas .Tg rb
2738 56c96eff 2022-08-30 thomas .It Xo
2739 56c96eff 2022-08-30 thomas .Cm rebase
2740 be94c032 2023-02-20 thomas .Op Fl aCclX
2741 56c96eff 2022-08-30 thomas .Op Ar branch
2742 56c96eff 2022-08-30 thomas .Xc
2743 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rb
2744 818c7501 2019-07-11 stsp Rebase commits on the specified
2745 818c7501 2019-07-11 stsp .Ar branch
2746 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
2747 818c7501 2019-07-11 stsp The
2748 818c7501 2019-07-11 stsp .Ar branch
2749 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
2750 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
2751 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
2752 818c7501 2019-07-11 stsp .Ar branch
2753 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
2754 f09e2405 2019-07-11 stsp of the specified
2755 818c7501 2019-07-11 stsp .Ar branch
2756 f09e2405 2019-07-11 stsp has been rebased.
2757 818c7501 2019-07-11 stsp .Pp
2758 2b6826ba 2020-02-24 stsp When
2759 2b6826ba 2020-02-24 stsp .Cm got rebase
2760 2b6826ba 2020-02-24 stsp is used as intended, the specified
2761 2b6826ba 2020-02-24 stsp .Ar branch
2762 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
2763 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
2764 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
2765 2b6826ba 2020-02-24 stsp .Cm got update -b
2766 2b6826ba 2020-02-24 stsp before starting the
2767 2b6826ba 2020-02-24 stsp .Cm rebase
2768 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
2769 2b6826ba 2020-02-24 stsp a common history with the specified
2770 2b6826ba 2020-02-24 stsp .Ar branch
2771 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
2772 c10890ce 2020-02-25 stsp remote repository.
2773 2b6826ba 2020-02-24 stsp .Pp
2774 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
2775 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
2776 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
2777 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
2778 818c7501 2019-07-11 stsp .Ar branch ,
2779 818c7501 2019-07-11 stsp but with different commit IDs.
2780 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
2781 f09e2405 2019-07-11 stsp the new version of the specified
2782 818c7501 2019-07-11 stsp .Ar branch
2783 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
2784 d4dddcbf 2022-07-22 thomas If author information is available via the
2785 d4dddcbf 2022-07-22 thomas .Ev GOT_AUTHOR
2786 d4dddcbf 2022-07-22 thomas environment variable,
2787 d4dddcbf 2022-07-22 thomas .Xr got.conf 5
2788 d4dddcbf 2022-07-22 thomas or Git's
2789 d4dddcbf 2022-07-22 thomas .Dv user.name
2790 d4dddcbf 2022-07-22 thomas and
2791 d4dddcbf 2022-07-22 thomas .Dv user.email
2792 d4dddcbf 2022-07-22 thomas configuration settings, this author information will be used to identify
2793 d4dddcbf 2022-07-22 thomas the
2794 d4dddcbf 2022-07-22 thomas .Dq committer
2795 d4dddcbf 2022-07-22 thomas of rebased commits.
2796 e600f124 2021-03-21 stsp .Pp
2797 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
2798 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2799 e600f124 2021-03-21 stsp reference namespace.
2800 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
2801 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2802 e600f124 2021-03-21 stsp .Cm got rebase -l
2803 e600f124 2021-03-21 stsp command.
2804 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2805 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2806 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2807 818c7501 2019-07-11 stsp .Pp
2808 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
2809 818c7501 2019-07-11 stsp using the following status codes:
2810 818c7501 2019-07-11 stsp .Bl -column YXZ description
2811 818c7501 2019-07-11 stsp .It G Ta file was merged
2812 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
2813 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
2814 818c7501 2019-07-11 stsp .It D Ta file was deleted
2815 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2816 818c7501 2019-07-11 stsp .It A Ta new file was added
2817 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2818 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2819 5ef14e63 2019-06-02 stsp .El
2820 818c7501 2019-07-11 stsp .Pp
2821 4b06140e 2022-03-22 thomas If merge conflicts occur, the rebase operation is interrupted and may
2822 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
2823 bb494413 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
2824 bb494413 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
2825 bb494413 2021-09-28 thomas the rebase operation will be interrupted to prevent potentially incomplete
2826 bb494413 2021-09-28 thomas changes from being committed to the repository without user intervention.
2827 bb494413 2021-09-28 thomas The work tree may be modified as desired and the rebase operation can be
2828 bb494413 2021-09-28 thomas continued once the changes present in the work tree are considered complete.
2829 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
2830 818c7501 2019-07-11 stsp .Ar branch
2831 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
2832 818c7501 2019-07-11 stsp .Pp
2833 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
2834 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
2835 f09e2405 2019-07-11 stsp when the rebase operation continues.
2836 ff0d2220 2019-07-11 stsp .Pp
2837 818c7501 2019-07-11 stsp .Cm got rebase
2838 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
2839 8dbcf388 2022-09-04 thomas If the
2840 8dbcf388 2022-09-04 thomas .Ar branch
2841 8dbcf388 2022-09-04 thomas is not in the
2842 8dbcf388 2022-09-04 thomas .Dq refs/heads/
2843 8dbcf388 2022-09-04 thomas reference namespace, the branch may not be rebased.
2844 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
2845 4b06140e 2022-03-22 thomas branch, then the work tree must first be updated with
2846 818c7501 2019-07-11 stsp .Cm got update .
2847 4ed9f614 2019-08-04 stsp If changes have been staged with
2848 4ed9f614 2019-08-04 stsp .Cm got stage ,
2849 bc3056e3 2019-08-18 stsp these changes must first be committed with
2850 4ed9f614 2019-08-04 stsp .Cm got commit
2851 4ed9f614 2019-08-04 stsp or unstaged with
2852 4ed9f614 2019-08-04 stsp .Cm got unstage .
2853 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
2854 f09e2405 2019-07-11 stsp committed with
2855 f09e2405 2019-07-11 stsp .Cm got commit
2856 f09e2405 2019-07-11 stsp or reverted with
2857 f09e2405 2019-07-11 stsp .Cm got revert .
2858 64c6d990 2019-07-11 stsp If the
2859 64c6d990 2019-07-11 stsp .Ar branch
2860 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
2861 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
2862 818c7501 2019-07-11 stsp .Pp
2863 7d5807f4 2019-07-11 stsp The
2864 8bcebf69 2023-01-08 thomas .Cm got update ,
2865 8bcebf69 2023-01-08 thomas .Cm got integrate ,
2866 8bcebf69 2023-01-08 thomas .Cm got merge ,
2867 8bcebf69 2023-01-08 thomas .Cm got commit ,
2868 7d5807f4 2019-07-11 stsp and
2869 8bcebf69 2023-01-08 thomas .Cm got histedit
2870 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
2871 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
2872 7d5807f4 2019-07-11 stsp conflict resolution purposes.
2873 818c7501 2019-07-11 stsp .Pp
2874 d10218e7 2021-11-04 thomas If the specified
2875 d10218e7 2021-11-04 thomas .Ar branch
2876 4b06140e 2022-03-22 thomas is already based on the work tree's current branch, then no commits
2877 d10218e7 2021-11-04 thomas need to be rebased and
2878 d10218e7 2021-11-04 thomas .Cm got rebase
2879 d10218e7 2021-11-04 thomas will simply switch the work tree to the specified
2880 d10218e7 2021-11-04 thomas .Ar branch
2881 d10218e7 2021-11-04 thomas and update files in the work tree accordingly.
2882 d10218e7 2021-11-04 thomas .Pp
2883 818c7501 2019-07-11 stsp The options for
2884 818c7501 2019-07-11 stsp .Cm got rebase
2885 818c7501 2019-07-11 stsp are as follows:
2886 818c7501 2019-07-11 stsp .Bl -tag -width Ds
2887 818c7501 2019-07-11 stsp .It Fl a
2888 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
2889 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2890 be94c032 2023-02-20 thomas .It Fl C
2891 be94c032 2023-02-20 thomas Allow a rebase operation to continue with files in conflicted status.
2892 be94c032 2023-02-20 thomas This option should generally be avoided, and can only be used with the
2893 be94c032 2023-02-20 thomas .Fl c
2894 be94c032 2023-02-20 thomas option.
2895 818c7501 2019-07-11 stsp .It Fl c
2896 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
2897 79878eb8 2023-07-05 thomas If this option is used, no other command-line arguments are allowed except
2898 79878eb8 2023-07-05 thomas .Fl C .
2899 e600f124 2021-03-21 stsp .It Fl l
2900 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
2901 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2902 e600f124 2021-03-21 stsp reference namespace.
2903 e600f124 2021-03-21 stsp .Pp
2904 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2905 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
2906 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2907 e600f124 2021-03-21 stsp Given these object IDs,
2908 e600f124 2021-03-21 stsp the
2909 e600f124 2021-03-21 stsp .Cm got log
2910 e600f124 2021-03-21 stsp command with the
2911 e600f124 2021-03-21 stsp .Fl c
2912 e600f124 2021-03-21 stsp and
2913 e600f124 2021-03-21 stsp .Fl x
2914 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2915 e600f124 2021-03-21 stsp and the
2916 e600f124 2021-03-21 stsp .Cm got branch
2917 e600f124 2021-03-21 stsp command with the
2918 e600f124 2021-03-21 stsp .Fl c
2919 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
2920 e600f124 2021-03-21 stsp .Pp
2921 e600f124 2021-03-21 stsp If a
2922 e600f124 2021-03-21 stsp .Ar branch
2923 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2924 e600f124 2021-03-21 stsp branch.
2925 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2926 e600f124 2021-03-21 stsp .Pp
2927 e600f124 2021-03-21 stsp If this option is used,
2928 e600f124 2021-03-21 stsp .Cm got rebase
2929 e600f124 2021-03-21 stsp does not require a work tree.
2930 e600f124 2021-03-21 stsp None of the other options can be used together with
2931 e600f124 2021-03-21 stsp .Fl l .
2932 643b85bc 2021-07-16 stsp .It Fl X
2933 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
2934 643b85bc 2021-07-16 stsp in the
2935 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
2936 643b85bc 2021-07-16 stsp reference namespace.
2937 643b85bc 2021-07-16 stsp .Pp
2938 643b85bc 2021-07-16 stsp If a
2939 643b85bc 2021-07-16 stsp .Ar branch
2940 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2941 643b85bc 2021-07-16 stsp this branch.
2942 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2943 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
2944 643b85bc 2021-07-16 stsp .Pp
2945 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2946 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2947 643b85bc 2021-07-16 stsp Git's garbage collector or
2948 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2949 643b85bc 2021-07-16 stsp .Pp
2950 643b85bc 2021-07-16 stsp If this option is used,
2951 643b85bc 2021-07-16 stsp .Cm got rebase
2952 643b85bc 2021-07-16 stsp does not require a work tree.
2953 643b85bc 2021-07-16 stsp None of the other options can be used together with
2954 643b85bc 2021-07-16 stsp .Fl X .
2955 818c7501 2019-07-11 stsp .El
2956 e8aa341a 2021-10-08 thomas .Tg he
2957 56c96eff 2022-08-30 thomas .It Xo
2958 56c96eff 2022-08-30 thomas .Cm histedit
2959 be94c032 2023-02-20 thomas .Op Fl aCcdeflmX
2960 56c96eff 2022-08-30 thomas .Op Fl F Ar histedit-script
2961 56c96eff 2022-08-30 thomas .Op Ar branch
2962 56c96eff 2022-08-30 thomas .Xc
2963 d912d125 2021-11-04 thomas .Dl Pq alias: Cm he
2964 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
2965 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
2966 d4dddcbf 2022-07-22 thomas .Pp
2967 d4dddcbf 2022-07-22 thomas The
2968 d4dddcbf 2022-07-22 thomas .Cm got histedit
2969 d4dddcbf 2022-07-22 thomas command requires the
2970 d4dddcbf 2022-07-22 thomas .Ev GOT_AUTHOR
2971 d4dddcbf 2022-07-22 thomas environment variable to be set,
2972 d4dddcbf 2022-07-22 thomas unless an author has been configured in
2973 d4dddcbf 2022-07-22 thomas .Xr got.conf 5
2974 d4dddcbf 2022-07-22 thomas or Git's
2975 d4dddcbf 2022-07-22 thomas .Dv user.name
2976 d4dddcbf 2022-07-22 thomas and
2977 d4dddcbf 2022-07-22 thomas .Dv user.email
2978 d4dddcbf 2022-07-22 thomas configuration settings can be obtained from the repository's
2979 d4dddcbf 2022-07-22 thomas .Pa .git/config
2980 d4dddcbf 2022-07-22 thomas file or from Git's global
2981 d4dddcbf 2022-07-22 thomas .Pa ~/.gitconfig
2982 d4dddcbf 2022-07-22 thomas configuration file.
2983 6e54d307 2020-02-24 stsp .Pp
2984 6e54d307 2020-02-24 stsp Before starting a
2985 6e54d307 2020-02-24 stsp .Cm histedit
2986 4b06140e 2022-03-22 thomas operation, the work tree's current branch must be set with
2987 6e54d307 2020-02-24 stsp .Cm got update -b
2988 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
2989 6e54d307 2020-02-24 stsp current branch of the work tree.
2990 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
2991 6e54d307 2020-02-24 stsp touched by the
2992 6e54d307 2020-02-24 stsp .Cm histedit
2993 6e54d307 2020-02-24 stsp operation.
2994 0ebf8283 2019-07-24 stsp .Pp
2995 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
2996 6e54d307 2020-02-24 stsp must be set with
2997 6e54d307 2020-02-24 stsp .Cm got update -c
2998 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
2999 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
3000 6e54d307 2020-02-24 stsp by the
3001 6e54d307 2020-02-24 stsp .Cm histedit
3002 6e54d307 2020-02-24 stsp operation.
3003 6e54d307 2020-02-24 stsp .Pp
3004 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
3005 0ebf8283 2019-07-24 stsp .Ar histedit script
3006 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
3007 46fa4c83 2020-02-24 stsp command line, or generated with the
3008 bbf6b418 2023-03-01 thomas .Fl d ,
3009 bbf6b418 2023-03-01 thomas .Fl e ,
3010 bbf6b418 2023-03-01 thomas .Fl f ,
3011 466785b9 2020-12-10 jrick or
3012 083957f4 2020-02-24 stsp .Fl m
3013 466785b9 2020-12-10 jrick options.
3014 bccae03f 2023-07-17 thomas Quitting the editor without saving the file will abort the histedit operation.
3015 083957f4 2020-02-24 stsp .Pp
3016 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
3017 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
3018 0ebf8283 2019-07-24 stsp whitespace and an argument.
3019 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
3020 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
3021 0ebf8283 2019-07-24 stsp Lines which begin with the
3022 0ebf8283 2019-07-24 stsp .Sq #
3023 0ebf8283 2019-07-24 stsp character are ignored entirely.
3024 0ebf8283 2019-07-24 stsp .Pp
3025 f3a5718a 2022-07-12 thomas The available histedit script commands are as follows:
3026 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
3027 f3a5718a 2022-07-12 thomas .It Cm pick Ar commit Ta Use the specified commit as it is.
3028 71654e8d 2023-03-01 thomas .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
3029 71654e8d 2023-03-01 thomas then interrupt the histedit operation for amending, without creating a commit.
3030 49f76ad0 2023-03-01 thomas While the histedit operation is interrupted arbitrary files may be edited,
3031 49f76ad0 2023-03-01 thomas and commands which manipulate the work tree can be used freely.
3032 49f76ad0 2023-03-01 thomas The
3033 49f76ad0 2023-03-01 thomas .Cm got add
3034 49f76ad0 2023-03-01 thomas and
3035 49f76ad0 2023-03-01 thomas .Cm got remove
3036 49f76ad0 2023-03-01 thomas commands can be used to add new files or remove existing ones.
3037 49f76ad0 2023-03-01 thomas The
3038 49f76ad0 2023-03-01 thomas .Cm got revert -p
3039 49f76ad0 2023-03-01 thomas command can be used to eliminate arbitrary changes from files in the work tree.
3040 49f76ad0 2023-03-01 thomas The
3041 49f76ad0 2023-03-01 thomas .Cm got stage -p
3042 49f76ad0 2023-03-01 thomas command may be used to prepare a subset of changes for inclusion in the
3043 49f76ad0 2023-03-01 thomas next commit.
3044 49f76ad0 2023-03-01 thomas Finally, the
3045 49f76ad0 2023-03-01 thomas .Cm got commit
3046 49f76ad0 2023-03-01 thomas command can be used to insert arbitrary commits into the edited history.
3047 49f76ad0 2023-03-01 thomas Regular editing of history must eventually be resumed by running
3048 49f76ad0 2023-03-01 thomas .Cm got histedit -c .
3049 f3a5718a 2022-07-12 thomas .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3050 0ebf8283 2019-07-24 stsp listed further below that will be used.
3051 f3a5718a 2022-07-12 thomas .It Cm drop Ar commit Ta Remove this commit from the edited history.
3052 f52e24d8 2023-10-28 thomas .It Cm mesg Ar commit Ta Open an editor to create a new log message for this
3053 f52e24d8 2023-10-28 thomas commit.
3054 0ebf8283 2019-07-24 stsp .El
3055 0ebf8283 2019-07-24 stsp .Pp
3056 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
3057 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
3058 5b87815e 2020-03-05 stsp No commit may be listed more than once.
3059 0ebf8283 2019-07-24 stsp .Pp
3060 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
3061 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
3062 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
3063 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
3064 498a90b7 2019-07-25 stsp switched to it.
3065 0ebf8283 2019-07-24 stsp .Pp
3066 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
3067 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
3068 e600f124 2021-03-21 stsp reference namespace.
3069 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
3070 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
3071 e600f124 2021-03-21 stsp .Cm got histedit -l
3072 e600f124 2021-03-21 stsp command.
3073 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
3074 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
3075 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
3076 e600f124 2021-03-21 stsp .Pp
3077 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
3078 0ebf8283 2019-07-24 stsp using the following status codes:
3079 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
3080 0ebf8283 2019-07-24 stsp .It G Ta file was merged
3081 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
3082 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
3083 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
3084 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
3085 0ebf8283 2019-07-24 stsp .It A Ta new file was added
3086 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
3087 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
3088 0ebf8283 2019-07-24 stsp .El
3089 0ebf8283 2019-07-24 stsp .Pp
3090 4b06140e 2022-03-22 thomas If merge conflicts occur, the histedit operation is interrupted and may
3091 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
3092 dddbe150 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
3093 dddbe150 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
3094 dddbe150 2021-09-28 thomas the histedit operation will be interrupted to prevent potentially incomplete
3095 dddbe150 2021-09-28 thomas changes from being committed to the repository without user intervention.
3096 dddbe150 2021-09-28 thomas The work tree may be modified as desired and the histedit operation can be
3097 dddbe150 2021-09-28 thomas continued once the changes present in the work tree are considered complete.
3098 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
3099 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
3100 0ebf8283 2019-07-24 stsp .Pp
3101 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
3102 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
3103 0ebf8283 2019-07-24 stsp when the histedit operation continues.
3104 0ebf8283 2019-07-24 stsp .Pp
3105 0ebf8283 2019-07-24 stsp .Cm got histedit
3106 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
3107 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
3108 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
3109 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
3110 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
3111 0ebf8283 2019-07-24 stsp to a single base commit with
3112 0ebf8283 2019-07-24 stsp .Cm got update .
3113 4ed9f614 2019-08-04 stsp If changes have been staged with
3114 4ed9f614 2019-08-04 stsp .Cm got stage ,
3115 bc3056e3 2019-08-18 stsp these changes must first be committed with
3116 4ed9f614 2019-08-04 stsp .Cm got commit
3117 4ed9f614 2019-08-04 stsp or unstaged with
3118 4ed9f614 2019-08-04 stsp .Cm got unstage .
3119 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
3120 0ebf8283 2019-07-24 stsp committed with
3121 0ebf8283 2019-07-24 stsp .Cm got commit
3122 0ebf8283 2019-07-24 stsp or reverted with
3123 0ebf8283 2019-07-24 stsp .Cm got revert .
3124 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
3125 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
3126 0ebf8283 2019-07-24 stsp .Pp
3127 0ebf8283 2019-07-24 stsp The
3128 7ef62c4e 2020-02-24 stsp .Cm got update ,
3129 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
3130 8bcebf69 2023-01-08 thomas .Cm got merge ,
3131 65db4ffb 2020-02-24 stsp and
3132 65db4ffb 2020-02-24 stsp .Cm got integrate
3133 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
3134 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
3135 0ebf8283 2019-07-24 stsp .Cm got commit
3136 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
3137 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
3138 0ebf8283 2019-07-24 stsp .Pp
3139 0ebf8283 2019-07-24 stsp The options for
3140 0ebf8283 2019-07-24 stsp .Cm got histedit
3141 0ebf8283 2019-07-24 stsp are as follows:
3142 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
3143 0ebf8283 2019-07-24 stsp .It Fl a
3144 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
3145 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
3146 be94c032 2023-02-20 thomas .It Fl C
3147 be94c032 2023-02-20 thomas Allow a histedit operation to continue with files in conflicted status.
3148 be94c032 2023-02-20 thomas This option should generally be avoided, and can only be used with the
3149 be94c032 2023-02-20 thomas .Fl c
3150 be94c032 2023-02-20 thomas option.
3151 0ebf8283 2019-07-24 stsp .It Fl c
3152 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
3153 79878eb8 2023-07-05 thomas If this option is used, no other command-line arguments are allowed except
3154 79878eb8 2023-07-05 thomas .Fl C .
3155 070c80a5 2023-01-31 thomas .It Fl d
3156 070c80a5 2023-01-31 thomas Drop all commits.
3157 070c80a5 2023-01-31 thomas This option is a quick equivalent to a histedit script which drops all
3158 070c80a5 2023-01-31 thomas commits.
3159 070c80a5 2023-01-31 thomas The
3160 070c80a5 2023-01-31 thomas .Fl d
3161 070c80a5 2023-01-31 thomas option can only be used when starting a new histedit operation.
3162 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
3163 c50a7455 2021-10-04 thomas .It Fl e
3164 c50a7455 2021-10-04 thomas Interrupt the histedit operation for editing after merging each commit.
3165 c50a7455 2021-10-04 thomas This option is a quick equivalent to a histedit script which uses the
3166 c50a7455 2021-10-04 thomas .Cm edit
3167 c50a7455 2021-10-04 thomas command for all commits.
3168 c50a7455 2021-10-04 thomas The
3169 c50a7455 2021-10-04 thomas .Fl e
3170 c50a7455 2021-10-04 thomas option can only be used when starting a new histedit operation.
3171 c50a7455 2021-10-04 thomas If this option is used, no other command-line arguments are allowed.
3172 d6506a3d 2022-08-16 thomas .It Fl F Ar histedit-script
3173 d6506a3d 2022-08-16 thomas Use the specified
3174 d6506a3d 2022-08-16 thomas .Ar histedit-script
3175 d6506a3d 2022-08-16 thomas instead of opening a temporary file in an editor where a histedit script
3176 d6506a3d 2022-08-16 thomas can be written.
3177 466785b9 2020-12-10 jrick .It Fl f
3178 466785b9 2020-12-10 jrick Fold all commits into a single commit.
3179 466785b9 2020-12-10 jrick This option is a quick equivalent to a histedit script which folds all
3180 466785b9 2020-12-10 jrick commits, combining them all into one commit.
3181 2a78779e 2020-12-11 stsp The
3182 2a78779e 2020-12-11 stsp .Fl f
3183 2a78779e 2020-12-11 stsp option can only be used when starting a new histedit operation.
3184 466785b9 2020-12-10 jrick If this option is used, no other command-line arguments are allowed.
3185 e600f124 2021-03-21 stsp .It Fl l
3186 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
3187 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
3188 e600f124 2021-03-21 stsp reference namespace.
3189 e600f124 2021-03-21 stsp .Pp
3190 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
3191 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
3192 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
3193 e600f124 2021-03-21 stsp Given these object IDs,
3194 e600f124 2021-03-21 stsp the
3195 e600f124 2021-03-21 stsp .Cm got log
3196 e600f124 2021-03-21 stsp command with the
3197 e600f124 2021-03-21 stsp .Fl c
3198 e600f124 2021-03-21 stsp and
3199 e600f124 2021-03-21 stsp .Fl x
3200 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
3201 e600f124 2021-03-21 stsp and the
3202 e600f124 2021-03-21 stsp .Cm got branch
3203 e600f124 2021-03-21 stsp command with the
3204 e600f124 2021-03-21 stsp .Fl c
3205 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
3206 e600f124 2021-03-21 stsp .Pp
3207 e600f124 2021-03-21 stsp If a
3208 e600f124 2021-03-21 stsp .Ar branch
3209 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
3210 e600f124 2021-03-21 stsp branch.
3211 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
3212 e600f124 2021-03-21 stsp .Pp
3213 e600f124 2021-03-21 stsp If this option is used,
3214 e600f124 2021-03-21 stsp .Cm got histedit
3215 e600f124 2021-03-21 stsp does not require a work tree.
3216 e600f124 2021-03-21 stsp None of the other options can be used together with
3217 e600f124 2021-03-21 stsp .Fl l .
3218 d6506a3d 2022-08-16 thomas .It Fl m
3219 d6506a3d 2022-08-16 thomas Edit log messages only.
3220 d6506a3d 2022-08-16 thomas This option is a quick equivalent to a histedit script which edits
3221 d6506a3d 2022-08-16 thomas only log messages but otherwise leaves every picked commit as-is.
3222 d6506a3d 2022-08-16 thomas The
3223 d6506a3d 2022-08-16 thomas .Fl m
3224 d6506a3d 2022-08-16 thomas option can only be used when starting a new histedit operation.
3225 d6506a3d 2022-08-16 thomas If this option is used, no other command-line arguments are allowed.
3226 643b85bc 2021-07-16 stsp .It Fl X
3227 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
3228 643b85bc 2021-07-16 stsp in the
3229 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
3230 643b85bc 2021-07-16 stsp reference namespace.
3231 643b85bc 2021-07-16 stsp .Pp
3232 643b85bc 2021-07-16 stsp If a
3233 643b85bc 2021-07-16 stsp .Ar branch
3234 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
3235 643b85bc 2021-07-16 stsp this branch.
3236 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
3237 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
3238 643b85bc 2021-07-16 stsp .Pp
3239 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
3240 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
3241 643b85bc 2021-07-16 stsp Git's garbage collector or
3242 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
3243 643b85bc 2021-07-16 stsp .Pp
3244 643b85bc 2021-07-16 stsp If this option is used,
3245 643b85bc 2021-07-16 stsp .Cm got histedit
3246 643b85bc 2021-07-16 stsp does not require a work tree.
3247 643b85bc 2021-07-16 stsp None of the other options can be used together with
3248 643b85bc 2021-07-16 stsp .Fl X .
3249 818c7501 2019-07-11 stsp .El
3250 e8aa341a 2021-10-08 thomas .Tg ig
3251 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
3252 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ig
3253 2822a352 2019-10-15 stsp Integrate the specified
3254 2822a352 2019-10-15 stsp .Ar branch
3255 2822a352 2019-10-15 stsp into the work tree's current branch.
3256 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
3257 2822a352 2019-10-15 stsp .Ar branch ,
3258 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
3259 2822a352 2019-10-15 stsp head commit of the integrated
3260 2822a352 2019-10-15 stsp .Ar branch .
3261 2822a352 2019-10-15 stsp .Pp
3262 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
3263 2822a352 2019-10-15 stsp will be pointing at the same commit.
3264 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
3265 2822a352 2019-10-15 stsp In case the integrated
3266 2822a352 2019-10-15 stsp .Ar branch
3267 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
3268 2822a352 2019-10-15 stsp .Cm got branch -d .
3269 2822a352 2019-10-15 stsp .Pp
3270 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
3271 2822a352 2019-10-15 stsp .Bl -column YXZ description
3272 2822a352 2019-10-15 stsp .It U Ta file was updated
3273 2822a352 2019-10-15 stsp .It D Ta file was deleted
3274 2822a352 2019-10-15 stsp .It A Ta new file was added
3275 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
3276 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
3277 2822a352 2019-10-15 stsp .El
3278 2822a352 2019-10-15 stsp .Pp
3279 2822a352 2019-10-15 stsp .Cm got integrate
3280 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
3281 2822a352 2019-10-15 stsp Most importantly, the
3282 2822a352 2019-10-15 stsp .Ar branch
3283 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
3284 2822a352 2019-10-15 stsp .Cm got rebase
3285 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
3286 2822a352 2019-10-15 stsp resolve merge conflicts.
3287 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
3288 2822a352 2019-10-15 stsp to a single base commit with
3289 2822a352 2019-10-15 stsp .Cm got update .
3290 2822a352 2019-10-15 stsp If changes have been staged with
3291 2822a352 2019-10-15 stsp .Cm got stage ,
3292 2822a352 2019-10-15 stsp these changes must first be committed with
3293 2822a352 2019-10-15 stsp .Cm got commit
3294 2822a352 2019-10-15 stsp or unstaged with
3295 2822a352 2019-10-15 stsp .Cm got unstage .
3296 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
3297 2822a352 2019-10-15 stsp committed with
3298 2822a352 2019-10-15 stsp .Cm got commit
3299 2822a352 2019-10-15 stsp or reverted with
3300 2822a352 2019-10-15 stsp .Cm got revert .
3301 bea5ae74 2021-10-10 thomas .Tg mg
3302 56c96eff 2022-08-30 thomas .It Xo
3303 56c96eff 2022-08-30 thomas .Cm merge
3304 31009ade 2023-07-05 thomas .Op Fl aCcMn
3305 56c96eff 2022-08-30 thomas .Op Ar branch
3306 56c96eff 2022-08-30 thomas .Xc
3307 d912d125 2021-11-04 thomas .Dl Pq alias: Cm mg
3308 2b72f32d 2023-06-22 thomas Merge the specified
3309 2b72f32d 2023-06-22 thomas .Ar branch
3310 2b72f32d 2023-06-22 thomas into the current branch of the work tree.
3311 efba105a 2023-10-08 thomas If the branches have diverged, merge changes into the work tree
3312 efba105a 2023-10-08 thomas and create a merge commit.
3313 efba105a 2023-10-08 thomas Otherwise, if the specified
3314 2b72f32d 2023-06-22 thomas .Ar branch
3315 efba105a 2023-10-08 thomas is already based on the work tree's current branch, make the work tree's
3316 efba105a 2023-10-08 thomas current branch equivalent to the specified
3317 2b72f32d 2023-06-22 thomas .Ar branch
3318 efba105a 2023-10-08 thomas and update files in the work tree accordingly.
3319 10604dce 2021-09-24 thomas .Pp
3320 10604dce 2021-09-24 thomas Merge commits are commits based on multiple parent commits.
3321 efba105a 2023-10-08 thomas The tip commit of the work tree's current branch will be used as the
3322 efba105a 2023-10-08 thomas first parent.
3323 efba105a 2023-10-08 thomas The tip commit of the specified
3324 efba105a 2023-10-08 thomas .Ar branch
3325 efba105a 2023-10-08 thomas will be used as the second parent.
3326 efba105a 2023-10-08 thomas The work tree's current branch
3327 efba105a 2023-10-08 thomas must be in the
3328 4434a15a 2023-06-22 thomas .Dq refs/heads/
3329 efba105a 2023-10-08 thomas reference namespace and can be set with
3330 10604dce 2021-09-24 thomas .Cm got update -b
3331 10604dce 2021-09-24 thomas before starting the
3332 10604dce 2021-09-24 thomas .Cm merge
3333 efba105a 2023-10-08 thomas operation.
3334 10604dce 2021-09-24 thomas .Pp
3335 768705e3 2021-09-27 thomas No ancestral relationship between the two branches is required.
3336 768705e3 2021-09-27 thomas If the two branches have already been merged previously, only new changes
3337 768705e3 2021-09-27 thomas will be merged.
3338 768705e3 2021-09-27 thomas .Pp
3339 10604dce 2021-09-24 thomas It is not possible to create merge commits with more than two parents.
3340 10604dce 2021-09-24 thomas If more than one branch needs to be merged, then multiple merge commits
3341 10604dce 2021-09-24 thomas with two parents each can be created in sequence.
3342 10604dce 2021-09-24 thomas .Pp
3343 efba105a 2023-10-08 thomas If a linear project history is desired, then use of
3344 efba105a 2023-10-08 thomas .Cm got rebase
3345 efba105a 2023-10-08 thomas should generally be preferred over
3346 efba105a 2023-10-08 thomas .Cm got merge .
3347 efba105a 2023-10-08 thomas However, even strictly linear projects may require occasional merge commits,
3348 efba105a 2023-10-08 thomas for example in order to merge in new versions of third-party code stored
3349 efba105a 2023-10-08 thomas on
3350 efba105a 2023-10-08 thomas .Dq vendor
3351 efba105a 2023-10-08 thomas branches created with
3352 efba105a 2023-10-08 thomas .Cm got import .
3353 efba105a 2023-10-08 thomas .Pp
3354 10604dce 2021-09-24 thomas While merging changes found on the
3355 10604dce 2021-09-24 thomas .Ar branch
3356 10604dce 2021-09-24 thomas into the work tree, show the status of each affected file,
3357 10604dce 2021-09-24 thomas using the following status codes:
3358 10604dce 2021-09-24 thomas .Bl -column YXZ description
3359 10604dce 2021-09-24 thomas .It G Ta file was merged
3360 10604dce 2021-09-24 thomas .It C Ta file was merged and conflicts occurred during merge
3361 10604dce 2021-09-24 thomas .It ! Ta changes destined for a missing file were not merged
3362 10604dce 2021-09-24 thomas .It D Ta file was deleted
3363 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
3364 10604dce 2021-09-24 thomas .It A Ta new file was added
3365 10604dce 2021-09-24 thomas .It \(a~ Ta changes destined for a non-regular file were not merged
3366 10604dce 2021-09-24 thomas .It ? Ta changes destined for an unversioned file were not merged
3367 10604dce 2021-09-24 thomas .El
3368 10604dce 2021-09-24 thomas .Pp
3369 10604dce 2021-09-24 thomas If merge conflicts occur, the merge operation is interrupted and conflicts
3370 10604dce 2021-09-24 thomas must be resolved before the merge operation can continue.
3371 8cf2970b 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
3372 8cf2970b 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
3373 10604dce 2021-09-24 thomas the merge operation will be interrupted to prevent potentially incomplete
3374 10604dce 2021-09-24 thomas changes from being committed to the repository without user intervention.
3375 10604dce 2021-09-24 thomas The work tree may be modified as desired and the merge can be continued
3376 10604dce 2021-09-24 thomas once the changes present in the work tree are considered complete.
3377 10604dce 2021-09-24 thomas Alternatively, the merge operation may be aborted which will leave
3378 10604dce 2021-09-24 thomas the work tree's current branch unmodified.
3379 10604dce 2021-09-24 thomas .Pp
3380 10604dce 2021-09-24 thomas .Cm got merge
3381 10604dce 2021-09-24 thomas will refuse to run if certain preconditions are not met.
3382 4434a15a 2023-06-22 thomas If the work tree's current branch is not in the
3383 4434a15a 2023-06-22 thomas .Dq refs/heads/
3384 4434a15a 2023-06-22 thomas reference namespace then the work tree must first be switched to a
3385 4434a15a 2023-06-22 thomas branch in the
3386 4434a15a 2023-06-22 thomas .Dq refs/heads/
3387 4434a15a 2023-06-22 thomas namespace with
3388 4434a15a 2023-06-22 thomas .Cm got update -b .
3389 10604dce 2021-09-24 thomas If the work tree is not yet fully updated to the tip commit of its
3390 10604dce 2021-09-24 thomas branch, then the work tree must first be updated with
3391 10604dce 2021-09-24 thomas .Cm got update .
3392 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
3393 10604dce 2021-09-24 thomas to a single base commit with
3394 10604dce 2021-09-24 thomas .Cm got update .
3395 10604dce 2021-09-24 thomas If changes have been staged with
3396 10604dce 2021-09-24 thomas .Cm got stage ,
3397 10604dce 2021-09-24 thomas these changes must first be committed with
3398 10604dce 2021-09-24 thomas .Cm got commit
3399 10604dce 2021-09-24 thomas or unstaged with
3400 10604dce 2021-09-24 thomas .Cm got unstage .
3401 10604dce 2021-09-24 thomas If the work tree contains local changes, these changes must first be
3402 10604dce 2021-09-24 thomas committed with
3403 10604dce 2021-09-24 thomas .Cm got commit
3404 10604dce 2021-09-24 thomas or reverted with
3405 10604dce 2021-09-24 thomas .Cm got revert .
3406 10604dce 2021-09-24 thomas If the
3407 10604dce 2021-09-24 thomas .Ar branch
3408 10604dce 2021-09-24 thomas contains changes to files outside of the work tree's path prefix,
3409 10604dce 2021-09-24 thomas the work tree cannot be used to merge this branch.
3410 10604dce 2021-09-24 thomas .Pp
3411 10604dce 2021-09-24 thomas The
3412 10604dce 2021-09-24 thomas .Cm got update ,
3413 10604dce 2021-09-24 thomas .Cm got commit ,
3414 10604dce 2021-09-24 thomas .Cm got rebase ,
3415 ac93b2c5 2021-10-08 thomas .Cm got histedit ,
3416 10604dce 2021-09-24 thomas .Cm got integrate ,
3417 10604dce 2021-09-24 thomas and
3418 10604dce 2021-09-24 thomas .Cm got stage
3419 10604dce 2021-09-24 thomas commands will refuse to run while a merge operation is in progress.
3420 10604dce 2021-09-24 thomas Other commands which manipulate the work tree may be used for
3421 10604dce 2021-09-24 thomas conflict resolution purposes.
3422 10604dce 2021-09-24 thomas .Pp
3423 10604dce 2021-09-24 thomas The options for
3424 10604dce 2021-09-24 thomas .Cm got merge
3425 10604dce 2021-09-24 thomas are as follows:
3426 10604dce 2021-09-24 thomas .Bl -tag -width Ds
3427 10604dce 2021-09-24 thomas .It Fl a
3428 10604dce 2021-09-24 thomas Abort an interrupted merge operation.
3429 10604dce 2021-09-24 thomas If this option is used, no other command-line arguments are allowed.
3430 be94c032 2023-02-20 thomas .It Fl C
3431 be94c032 2023-02-20 thomas Allow a merge operation to continue with files in conflicted status.
3432 be94c032 2023-02-20 thomas This option should generally be avoided, and can only be used with the
3433 be94c032 2023-02-20 thomas .Fl c
3434 be94c032 2023-02-20 thomas option.
3435 10604dce 2021-09-24 thomas .It Fl c
3436 10604dce 2021-09-24 thomas Continue an interrupted merge operation.
3437 dcd455ee 2023-07-05 thomas If this option is used, no other command-line arguments are allowed except
3438 dcd455ee 2023-07-05 thomas .Fl C .
3439 31009ade 2023-07-05 thomas .It Fl M
3440 31009ade 2023-07-05 thomas Create a merge commit even if the branches have not diverged.
3441 ba34626b 2021-09-27 thomas .It Fl n
3442 ba34626b 2021-09-27 thomas Merge changes into the work tree as usual but do not create a merge
3443 ba34626b 2021-09-27 thomas commit immediately.
3444 ba34626b 2021-09-27 thomas The merge result can be adjusted as desired before a merge commit is
3445 ba34626b 2021-09-27 thomas created with
3446 ba34626b 2021-09-27 thomas .Cm got merge -c .
3447 ba34626b 2021-09-27 thomas Alternatively, the merge may be aborted with
3448 ba34626b 2021-09-27 thomas .Cm got merge -a .
3449 10604dce 2021-09-24 thomas .El
3450 e8aa341a 2021-10-08 thomas .Tg sg
3451 56c96eff 2022-08-30 thomas .It Xo
3452 56c96eff 2022-08-30 thomas .Cm stage
3453 56c96eff 2022-08-30 thomas .Op Fl lpS
3454 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
3455 56c96eff 2022-08-30 thomas .Op Ar path ...
3456 56c96eff 2022-08-30 thomas .Xc
3457 d912d125 2021-11-04 thomas .Dl Pq alias: Cm sg
3458 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
3459 2db2652d 2019-08-07 stsp If no
3460 2db2652d 2019-08-07 stsp .Ar path
3461 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
3462 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
3463 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
3464 4ed9f614 2019-08-04 stsp .Cm got status .
3465 4ed9f614 2019-08-04 stsp .Pp
3466 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
3467 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
3468 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
3469 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
3470 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
3471 9d8b19a4 2019-08-04 stsp .El
3472 9d8b19a4 2019-08-04 stsp .Pp
3473 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
3474 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
3475 9d8b19a4 2019-08-04 stsp committed.
3476 9d8b19a4 2019-08-04 stsp .Pp
3477 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
3478 4ed9f614 2019-08-04 stsp .Cm got commit ,
3479 4ed9f614 2019-08-04 stsp .Cm got status ,
3480 4ed9f614 2019-08-04 stsp and
3481 4ed9f614 2019-08-04 stsp .Cm got diff .
3482 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
3483 4ed9f614 2019-08-04 stsp .Cm got commit
3484 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
3485 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
3486 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
3487 4ed9f614 2019-08-04 stsp The
3488 4ed9f614 2019-08-04 stsp .Cm got status
3489 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
3490 4ed9f614 2019-08-04 stsp The
3491 4ed9f614 2019-08-04 stsp .Cm got diff
3492 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
3493 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
3494 4ed9f614 2019-08-04 stsp The
3495 4ed9f614 2019-08-04 stsp .Cm got revert
3496 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
3497 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
3498 4ed9f614 2019-08-04 stsp .Pp
3499 4ed9f614 2019-08-04 stsp The options for
3500 4ed9f614 2019-08-04 stsp .Cm got stage
3501 4ed9f614 2019-08-04 stsp are as follows:
3502 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
3503 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
3504 d6506a3d 2022-08-16 thomas With the
3505 d6506a3d 2022-08-16 thomas .Fl p
3506 d6506a3d 2022-08-16 thomas option, read
3507 d6506a3d 2022-08-16 thomas .Dq y ,
3508 d6506a3d 2022-08-16 thomas .Dq n ,
3509 d6506a3d 2022-08-16 thomas and
3510 d6506a3d 2022-08-16 thomas .Dq q
3511 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
3512 d6506a3d 2022-08-16 thomas .Ar response-script
3513 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
3514 4ed9f614 2019-08-04 stsp .It Fl l
3515 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
3516 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
3517 4b06140e 2022-03-22 thomas If paths were provided on the command line, show the staged paths
3518 1dd86744 2019-08-12 anthony among the specified paths.
3519 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
3520 dc424a06 2019-08-07 stsp .It Fl p
3521 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
3522 dc424a06 2019-08-07 stsp select or reject changes for staging based on
3523 dc424a06 2019-08-07 stsp .Dq y
3524 6d23ec10 2019-08-08 stsp (stage change),
3525 dc424a06 2019-08-07 stsp .Dq n
3526 6d23ec10 2019-08-08 stsp (reject change), and
3527 b353a198 2019-08-07 stsp .Dq q
3528 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
3529 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
3530 dc424a06 2019-08-07 stsp modified file content can be staged.
3531 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
3532 6d23ec10 2019-08-08 stsp their entirety.
3533 35213c7c 2020-07-23 stsp .It Fl S
3534 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
3535 af358f55 2020-07-23 stsp that is under version control.
3536 af358f55 2020-07-23 stsp By default,
3537 af358f55 2020-07-23 stsp .Cm got stage
3538 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
3539 35213c7c 2020-07-23 stsp As a precaution,
3540 35213c7c 2020-07-23 stsp .Nm
3541 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
3542 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
3543 af358f55 2020-07-23 stsp points outside of the work tree.
3544 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
3545 af358f55 2020-07-23 stsp .Dq make obj
3546 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
3547 af358f55 2020-07-23 stsp version control.
3548 4ed9f614 2019-08-04 stsp .El
3549 4ed9f614 2019-08-04 stsp .Pp
3550 4ed9f614 2019-08-04 stsp .Cm got stage
3551 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
3552 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
3553 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
3554 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
3555 4ed9f614 2019-08-04 stsp .Cm got update
3556 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
3557 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
3558 4ed9f614 2019-08-04 stsp .Pp
3559 4ed9f614 2019-08-04 stsp The
3560 4ed9f614 2019-08-04 stsp .Cm got update ,
3561 4ed9f614 2019-08-04 stsp .Cm got rebase ,
3562 1a70a207 2023-07-05 thomas .Cm got merge ,
3563 4ed9f614 2019-08-04 stsp and
3564 4ed9f614 2019-08-04 stsp .Cm got histedit
3565 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
3566 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
3567 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
3568 4ed9f614 2019-08-04 stsp .Cm got unstage
3569 4ed9f614 2019-08-04 stsp before it can be updated with
3570 4ed9f614 2019-08-04 stsp .Cm got update ,
3571 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
3572 e8aa341a 2021-10-08 thomas .Tg ug
3573 56c96eff 2022-08-30 thomas .It Xo
3574 56c96eff 2022-08-30 thomas .Cm unstage
3575 56c96eff 2022-08-30 thomas .Op Fl p
3576 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
3577 56c96eff 2022-08-30 thomas .Op Ar path ...
3578 56c96eff 2022-08-30 thomas .Xc
3579 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ug
3580 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
3581 4ed9f614 2019-08-04 stsp back into non-staged status.
3582 4ed9f614 2019-08-04 stsp If no
3583 4ed9f614 2019-08-04 stsp .Ar path
3584 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
3585 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
3586 4ed9f614 2019-08-04 stsp .Pp
3587 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
3588 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
3589 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
3590 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
3591 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
3592 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
3593 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
3594 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
3595 4ed9f614 2019-08-04 stsp .El
3596 2e1f37b0 2019-08-08 stsp .Pp
3597 2e1f37b0 2019-08-08 stsp The options for
3598 2e1f37b0 2019-08-08 stsp .Cm got unstage
3599 2e1f37b0 2019-08-08 stsp are as follows:
3600 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
3601 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
3602 2e1f37b0 2019-08-08 stsp With the
3603 2e1f37b0 2019-08-08 stsp .Fl p
3604 2e1f37b0 2019-08-08 stsp option, read
3605 2e1f37b0 2019-08-08 stsp .Dq y ,
3606 2e1f37b0 2019-08-08 stsp .Dq n ,
3607 2e1f37b0 2019-08-08 stsp and
3608 2e1f37b0 2019-08-08 stsp .Dq q
3609 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
3610 2e1f37b0 2019-08-08 stsp .Ar response-script
3611 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
3612 d6506a3d 2022-08-16 thomas .It Fl p
3613 d6506a3d 2022-08-16 thomas Instead of unstaging the entire content of a changed file, interactively
3614 d6506a3d 2022-08-16 thomas select or reject changes for unstaging based on
3615 d6506a3d 2022-08-16 thomas .Dq y
3616 d6506a3d 2022-08-16 thomas (unstage change),
3617 d6506a3d 2022-08-16 thomas .Dq n
3618 d6506a3d 2022-08-16 thomas (keep change staged), and
3619 d6506a3d 2022-08-16 thomas .Dq q
3620 d6506a3d 2022-08-16 thomas (quit unstaging this file) responses.
3621 d6506a3d 2022-08-16 thomas If a file is staged in modified status, individual patches derived from the
3622 d6506a3d 2022-08-16 thomas staged file content can be unstaged.
3623 d6506a3d 2022-08-16 thomas Files staged in added or deleted status may only be unstaged in their entirety.
3624 2e1f37b0 2019-08-08 stsp .El
3625 56c96eff 2022-08-30 thomas .It Xo
3626 56c96eff 2022-08-30 thomas .Cm cat
3627 56c96eff 2022-08-30 thomas .Op Fl P
3628 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
3629 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
3630 56c96eff 2022-08-30 thomas .Ar arg ...
3631 56c96eff 2022-08-30 thomas .Xc
3632 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
3633 896e9b6f 2019-08-26 stsp text format.
3634 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
3635 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
3636 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
3637 896e9b6f 2019-08-26 stsp .Pp
3638 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
3639 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
3640 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
3641 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
3642 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3643 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
3644 01073a5d 2019-08-22 stsp .Pp
3645 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
3646 896e9b6f 2019-08-26 stsp .Fl P
3647 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
3648 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
3649 896e9b6f 2019-08-26 stsp .Pp
3650 01073a5d 2019-08-22 stsp The options for
3651 01073a5d 2019-08-22 stsp .Cm got cat
3652 01073a5d 2019-08-22 stsp are as follows:
3653 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
3654 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
3655 896e9b6f 2019-08-26 stsp Look up paths in the specified
3656 896e9b6f 2019-08-26 stsp .Ar commit .
3657 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
3658 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
3659 9f625d2d 2023-07-19 thomas .Pp
3660 9f625d2d 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name
3661 9f625d2d 2023-07-19 thomas or keyword which will be resolved to a commit ID.
3662 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3663 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
3664 9f625d2d 2023-07-19 thomas The keywords
3665 3795e2b6 2023-07-19 thomas .Qq :base
3666 3795e2b6 2023-07-19 thomas and
3667 3795e2b6 2023-07-19 thomas .Qq :head
3668 9f625d2d 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
3669 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
3670 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
3671 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
3672 3795e2b6 2023-07-19 thomas Keywords and references may be appended with
3673 3795e2b6 2023-07-19 thomas .Qq :+
3674 3795e2b6 2023-07-19 thomas or
3675 3795e2b6 2023-07-19 thomas .Qq :-
3676 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
3677 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
3678 3795e2b6 2023-07-19 thomas for example,
3679 3795e2b6 2023-07-19 thomas .Sy :head:-2
3680 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
3681 3795e2b6 2023-07-19 thomas .Sy :base:+4
3682 3795e2b6 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
3683 3795e2b6 2023-07-19 thomas Similarly,
3684 3795e2b6 2023-07-19 thomas .Sy quux:-8
3685 3795e2b6 2023-07-19 thomas will denote the 8th generation ancestor of the commit resolved by the
3686 3795e2b6 2023-07-19 thomas .Qq quux
3687 3795e2b6 2023-07-19 thomas reference.
3688 3795e2b6 2023-07-19 thomas A
3689 3795e2b6 2023-07-19 thomas .Qq :+
3690 3795e2b6 2023-07-19 thomas or
3691 3795e2b6 2023-07-19 thomas .Qq :-
3692 3795e2b6 2023-07-19 thomas modifier without a trailing integer has an implicit
3693 3795e2b6 2023-07-19 thomas .Qq 1
3694 3795e2b6 2023-07-19 thomas appended
3695 3795e2b6 2023-07-19 thomas .Po e.g.,
3696 3795e2b6 2023-07-19 thomas .Sy :base:+
3697 3795e2b6 2023-07-19 thomas is equivalent to
3698 3795e2b6 2023-07-19 thomas .Sy :base:+1
3699 3795e2b6 2023-07-19 thomas .Pc .
3700 d6506a3d 2022-08-16 thomas .It Fl P
3701 d6506a3d 2022-08-16 thomas Interpret all arguments as paths only.
3702 d6506a3d 2022-08-16 thomas This option can be used to resolve ambiguity in cases where paths
3703 d6506a3d 2022-08-16 thomas look like tag names, reference names, or object IDs.
3704 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
3705 01073a5d 2019-08-22 stsp Use the repository at the specified path.
3706 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
3707 01073a5d 2019-08-22 stsp working directory.
3708 01073a5d 2019-08-22 stsp If this directory is a
3709 01073a5d 2019-08-22 stsp .Nm
3710 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
3711 4ed9f614 2019-08-04 stsp .El
3712 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
3713 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
3714 b2118c49 2020-07-28 stsp See
3715 b2118c49 2020-07-28 stsp .Xr got-worktree 5
3716 b2118c49 2020-07-28 stsp for details.
3717 b2118c49 2020-07-28 stsp .Pp
3718 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
3719 b2118c49 2020-07-28 stsp current working directory.
3720 b2118c49 2020-07-28 stsp .Pp
3721 b2118c49 2020-07-28 stsp If one or more
3722 b2118c49 2020-07-28 stsp .Ar path
3723 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
3724 b2118c49 2020-07-28 stsp files located at or within these paths.
3725 b2118c49 2020-07-28 stsp If a
3726 b2118c49 2020-07-28 stsp .Ar path
3727 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
3728 b2118c49 2020-07-28 stsp for all tracked files.
3729 01073a5d 2019-08-22 stsp .El
3730 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
3731 5daf5c53 2022-07-23 thomas .Bl -tag -width GOT_IGNORE_GITCONFIG
3732 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
3733 d4dddcbf 2022-07-22 thomas The author's name and email address, such as
3734 1d84e082 2024-01-26 thomas .Qq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3735 d4dddcbf 2022-07-22 thomas Used by the
3736 d4dddcbf 2022-07-22 thomas .Cm got commit ,
3737 d4dddcbf 2022-07-22 thomas .Cm got import ,
3738 d4dddcbf 2022-07-22 thomas .Cm got rebase ,
3739 1a70a207 2023-07-05 thomas .Cm got merge ,
3740 d4dddcbf 2022-07-22 thomas and
3741 d4dddcbf 2022-07-22 thomas .Cm got histedit
3742 d4dddcbf 2022-07-22 thomas commands.
3743 84792843 2019-08-09 stsp Because
3744 0e444aba 2019-08-08 stsp .Xr git 1
3745 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
3746 0e444aba 2019-08-08 stsp .Nm
3747 84792843 2019-08-09 stsp attempts to reject
3748 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
3749 84792843 2019-08-09 stsp environment variables with a missing email address.
3750 c9956ddf 2019-09-08 stsp .Pp
3751 93a300b2 2021-08-26 stsp .Ev GOT_AUTHOR will be overridden by configuration settings in
3752 50b0790e 2020-09-11 stsp .Xr got.conf 5
3753 50b0790e 2020-09-11 stsp or by Git's
3754 aba9c984 2019-09-08 stsp .Dv user.name
3755 aba9c984 2019-09-08 stsp and
3756 709ae9eb 2019-09-08 stsp .Dv user.email
3757 709ae9eb 2019-09-08 stsp configuration settings in the repository's
3758 aba9c984 2019-09-08 stsp .Pa .git/config
3759 50b0790e 2020-09-11 stsp file.
3760 257add31 2020-09-09 stsp The
3761 c9956ddf 2019-09-08 stsp .Dv user.name
3762 c9956ddf 2019-09-08 stsp and
3763 c9956ddf 2019-09-08 stsp .Dv user.email
3764 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
3765 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
3766 257add31 2020-09-09 stsp configuration file will only be used if neither
3767 257add31 2020-09-09 stsp .Xr got.conf 5
3768 257add31 2020-09-09 stsp nor the
3769 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
3770 257add31 2020-09-09 stsp environment variable provide author information.
3771 bd15e874 2023-01-20 thomas .It Ev GOT_IGNORE_GITCONFIG
3772 bd15e874 2023-01-20 thomas If this variable is set then any remote repository definitions or author
3773 bd15e874 2023-01-20 thomas information found in Git configuration files will be ignored.
3774 bd15e874 2023-01-20 thomas .It Ev GOT_LOG_DEFAULT_LIMIT
3775 bd15e874 2023-01-20 thomas The default limit on the number of commits traversed by
3776 bd15e874 2023-01-20 thomas .Cm got log .
3777 bd15e874 2023-01-20 thomas If set to zero, the limit is unbounded.
3778 bd15e874 2023-01-20 thomas This variable will be silently ignored if it is set to a non-numeric value.
3779 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
3780 23594da9 2019-05-13 stsp The editor spawned by
3781 8e7bd50a 2019-08-22 stsp .Cm got commit ,
3782 46215d2a 2020-09-11 stsp .Cm got histedit ,
3783 8e7bd50a 2019-08-22 stsp .Cm got import ,
3784 8e7bd50a 2019-08-22 stsp or
3785 8e7bd50a 2019-08-22 stsp .Cm got tag .
3786 5b735925 2020-09-15 stsp If not set, the
3787 f8da67e8 2023-03-01 thomas .Xr vi 1
3788 f8da67e8 2023-03-01 thomas text editor will be spawned.
3789 74416c47 2019-05-09 stsp .El
3790 257add31 2020-09-09 stsp .Sh FILES
3791 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
3792 257add31 2020-09-09 stsp .It Pa got.conf
3793 257add31 2020-09-09 stsp Repository-wide configuration settings for
3794 257add31 2020-09-09 stsp .Nm .
3795 50b0790e 2020-09-11 stsp If present, a
3796 50b0790e 2020-09-11 stsp .Xr got.conf 5
3797 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
3798 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
3799 257add31 2020-09-09 stsp .Pa config
3800 257add31 2020-09-09 stsp file.
3801 50b0790e 2020-09-11 stsp .Pp
3802 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
3803 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
3804 50b0790e 2020-09-11 stsp .Nm .
3805 50b0790e 2020-09-11 stsp If present, a
3806 1795b260 2021-04-02 kn .Xr got.conf 5
3807 50b0790e 2020-09-11 stsp configuration file in the
3808 50b0790e 2020-09-11 stsp .Pa .got
3809 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
3810 50b0790e 2020-09-11 stsp the repository's
3811 50b0790e 2020-09-11 stsp .Xr got.conf 5
3812 50b0790e 2020-09-11 stsp configuration file and Git's
3813 50b0790e 2020-09-11 stsp .Pa config
3814 50b0790e 2020-09-11 stsp file.
3815 257add31 2020-09-09 stsp .El
3816 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
3817 5c860e29 2018-03-12 stsp .Ex -std got
3818 97925469 2018-03-17 stsp .Sh EXAMPLES
3819 43e4eb1b 2021-08-29 stsp Enable tab-completion of
3820 43e4eb1b 2021-08-29 stsp .Nm
3821 43e4eb1b 2021-08-29 stsp command names in
3822 43e4eb1b 2021-08-29 stsp .Xr ksh 1 :
3823 43e4eb1b 2021-08-29 stsp .Pp
3824 e1d27370 2021-09-01 stsp .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3825 43e4eb1b 2021-08-29 stsp .Pp
3826 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
3827 f357763f 2023-06-22 thomas .Nm :
3828 fd039d72 2020-03-18 stsp .Pp
3829 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
3830 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
3831 fd039d72 2020-03-18 stsp .Pp
3832 f357763f 2023-06-22 thomas Unfortunately, many of the popular Git hosting sites do not offer anonymous
3833 f357763f 2023-06-22 thomas access via SSH.
3834 f357763f 2023-06-22 thomas Such sites will require an account to be created, and a public SSH key to be
3835 f357763f 2023-06-22 thomas uploaded to this account, before repository access via ssh:// URLs will work.
3836 f357763f 2023-06-22 thomas .Pp
3837 cda0eee6 2024-04-25 thomas.ad Most sites offer anonymous repository access via HTTPS:
3838 d83d9d5c 2019-05-13 stsp .Pp
3839 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
3840 cda0eee6 2024-04-25 thomas.ad .Dl $ got clone https://github.com/openbsd/src.git
3841 fa6e0e48 2019-05-23 stsp .Pp
3842 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
3843 3ce1b845 2019-07-15 stsp .Nm
3844 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
3845 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
3846 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
3847 fa6e0e48 2019-05-23 stsp .Pp
3848 27b10c3c 2022-07-04 thomas .Dl $ gotadmin init /var/git/src.git
3849 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3850 3ce1b845 2019-07-15 stsp .Pp
3851 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
3852 3ce1b845 2019-07-15 stsp .Pp
3853 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
3854 fa6e0e48 2019-05-23 stsp .Pp
3855 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
3856 e70c17ce 2019-05-22 stsp .Pp
3857 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
3858 33aa809d 2019-08-08 stsp .Pp
3859 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
3860 081470ac 2020-08-13 stsp .Pp
3861 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
3862 081470ac 2020-08-13 stsp .Pp
3863 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
3864 e70c17ce 2019-05-22 stsp .Pp
3865 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
3866 33aa809d 2019-08-08 stsp .Pp
3867 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
3868 e70c17ce 2019-05-22 stsp .Pp
3869 4e759de4 2019-06-26 stsp .Dl $ got branch -l
3870 7fc94106 2023-01-14 thomas .Pp
3871 7fc94106 2023-01-14 thomas As above, but list the most recently modified branches only:
3872 7fc94106 2023-01-14 thomas .Pp
3873 7fc94106 2023-01-14 thomas .Dl $ got branch -lt | head
3874 e70c17ce 2019-05-22 stsp .Pp
3875 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
3876 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
3877 d83d9d5c 2019-05-13 stsp which is forked off the
3878 d83d9d5c 2019-05-13 stsp .Dq master
3879 d83d9d5c 2019-05-13 stsp branch:
3880 d83d9d5c 2019-05-13 stsp .Pp
3881 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
3882 e70c17ce 2019-05-22 stsp .Pp
3883 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
3884 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
3885 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
3886 e70c17ce 2019-05-22 stsp .Pp
3887 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
3888 e70c17ce 2019-05-22 stsp .Pp
3889 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
3890 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
3891 fa6e0e48 2019-05-23 stsp .Pp
3892 fa6e0e48 2019-05-23 stsp .Dl $ got commit
3893 fa6e0e48 2019-05-23 stsp .Pp
3894 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
3895 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
3896 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
3897 fa6e0e48 2019-05-23 stsp .Pp
3898 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
3899 04e9dcf3 2020-04-18 stsp .Pp
3900 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
3901 04e9dcf3 2020-04-18 stsp .Xr patch 1
3902 04e9dcf3 2020-04-18 stsp could apply them in sequence:
3903 5b666081 2020-02-24 stsp .Pp
3904 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
3905 04e9dcf3 2020-04-18 stsp .Pp
3906 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
3907 5b666081 2020-02-24 stsp .Pp
3908 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
3909 5b666081 2020-02-24 stsp .Pp
3910 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
3911 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
3912 5b666081 2020-02-24 stsp .Pa sys/uvm :
3913 fa6e0e48 2019-05-23 stsp .Pp
3914 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
3915 5b666081 2020-02-24 stsp .Pp
3916 5b666081 2020-02-24 stsp And this command has the same effect:
3917 5b666081 2020-02-24 stsp .Pp
3918 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
3919 5b666081 2020-02-24 stsp .Pp
3920 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
3921 b2118c49 2020-07-28 stsp .Pp
3922 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
3923 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
3924 b2118c49 2020-07-28 stsp .Pp
3925 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
3926 e70c17ce 2019-05-22 stsp .Pp
3927 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
3928 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
3929 e70c17ce 2019-05-22 stsp .Pp
3930 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
3931 e70c17ce 2019-05-22 stsp with a pre-defined log message.
3932 e70c17ce 2019-05-22 stsp .Pp
3933 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
3934 95fc3404 2019-07-15 stsp .Pp
3935 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
3936 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
3937 1795b260 2021-04-02 kn .Pa /tmp/msg :
3938 bcbc2272 2020-05-20 stsp .Pp
3939 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
3940 bcbc2272 2020-05-20 stsp .Pp
3941 95fc3404 2019-07-15 stsp Update any work tree checked out from the
3942 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
3943 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
3944 95fc3404 2019-07-15 stsp .Pp
3945 95fc3404 2019-07-15 stsp .Dl $ got update
3946 ac90e726 2019-07-15 stsp .Pp
3947 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
3948 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
3949 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
3950 e70c17ce 2019-05-22 stsp .Pp
3951 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3952 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
3953 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
3954 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3955 ac90e726 2019-07-15 stsp .Pp
3956 a099809f 2021-08-27 stsp Fetch new changes on the remote repository's
3957 a099809f 2021-08-27 stsp .Dq master
3958 a099809f 2021-08-27 stsp branch, making them visible on the local repository's
3959 469dd726 2020-03-20 stsp .Dq origin/master
3960 469dd726 2020-03-20 stsp branch:
3961 fa6e0e48 2019-05-23 stsp .Pp
3962 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3963 469dd726 2020-03-20 stsp .Dl $ got fetch
3964 469dd726 2020-03-20 stsp .Pp
3965 469dd726 2020-03-20 stsp Rebase the local
3966 469dd726 2020-03-20 stsp .Dq master
3967 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
3968 469dd726 2020-03-20 stsp .Dq origin/master
3969 469dd726 2020-03-20 stsp branch:
3970 469dd726 2020-03-20 stsp .Pp
3971 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3972 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
3973 469dd726 2020-03-20 stsp .Dl $ got rebase master
3974 469dd726 2020-03-20 stsp .Pp
3975 fa6e0e48 2019-05-23 stsp Rebase the
3976 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
3977 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
3978 fa6e0e48 2019-05-23 stsp .Dq master
3979 fa6e0e48 2019-05-23 stsp branch.
3980 fa6e0e48 2019-05-23 stsp .Pp
3981 818c7501 2019-07-11 stsp .Dl $ got update -b master
3982 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
3983 7d7ffedb 2019-07-14 stsp .Pp
3984 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
3985 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
3986 1dd86744 2019-08-12 anthony .Ox Ns 's
3987 1dd86744 2019-08-12 anthony CVS tree:
3988 7d7ffedb 2019-07-14 stsp .Pp
3989 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3990 7d7ffedb 2019-07-14 stsp .Pp
3991 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
3992 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
3993 0ebf8283 2019-07-24 stsp branch:
3994 0ebf8283 2019-07-24 stsp .Pp
3995 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
3996 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
3997 0ebf8283 2019-07-24 stsp .Dl $ got histedit
3998 469dd726 2020-03-20 stsp .Pp
3999 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
4000 469dd726 2020-03-20 stsp .Cm git clone --bare
4001 7848a0e1 2020-03-19 stsp instead of
4002 7848a0e1 2020-03-19 stsp .Cm got clone ,
4003 ff2cf171 2019-07-28 stsp a Git
4004 ff2cf171 2019-07-28 stsp .Dq refspec
4005 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
4006 ff2cf171 2019-07-28 stsp into the
4007 ff2cf171 2019-07-28 stsp .Dq refs/remotes
4008 ff2cf171 2019-07-28 stsp namespace of the local repository.
4009 1795b260 2021-04-02 kn This can be achieved by setting Git's
4010 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
4011 ff2cf171 2019-07-28 stsp configuration variable to the value
4012 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
4013 ff2cf171 2019-07-28 stsp with the
4014 ff2cf171 2019-07-28 stsp .Cm git config
4015 ff2cf171 2019-07-28 stsp command:
4016 ff2cf171 2019-07-28 stsp .Pp
4017 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
4018 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
4019 eac81709 2020-03-21 stsp .Pp
4020 469dd726 2020-03-20 stsp Additionally, the
4021 469dd726 2020-03-20 stsp .Dq mirror
4022 469dd726 2020-03-20 stsp option must be disabled:
4023 ff2cf171 2019-07-28 stsp .Pp
4024 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
4025 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
4026 469dd726 2020-03-20 stsp .Pp
4027 ff2cf171 2019-07-28 stsp Alternatively, the following
4028 469dd726 2020-03-20 stsp .Xr git-fetch 1
4029 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
4030 ff2cf171 2019-07-28 stsp .Pa config
4031 ff2cf171 2019-07-28 stsp file:
4032 0ebf8283 2019-07-24 stsp .Pp
4033 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
4034 ff2cf171 2019-07-28 stsp .Dl url = ...
4035 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4036 469dd726 2020-03-20 stsp .Dl mirror = false
4037 ff2cf171 2019-07-28 stsp .Pp
4038 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
4039 ff2cf171 2019-07-28 stsp .Dq refs/heads
4040 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
4041 ff2cf171 2019-07-28 stsp .Cm got checkout
4042 ff2cf171 2019-07-28 stsp and, if needed, created with
4043 ff2cf171 2019-07-28 stsp .Cm got branch .
4044 ff2cf171 2019-07-28 stsp Branches in the
4045 a099809f 2021-08-27 stsp .Dq refs/remotes/origin
4046 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
4047 ff2cf171 2019-07-28 stsp repository with
4048 469dd726 2020-03-20 stsp .Cm got fetch
4049 469dd726 2020-03-20 stsp or
4050 469dd726 2020-03-20 stsp .Xr git-fetch 1
4051 a099809f 2021-08-27 stsp without extra command line arguments.
4052 a099809f 2021-08-27 stsp Newly fetched changes can be examined with
4053 a099809f 2021-08-27 stsp .Cm got log .
4054 ff2cf171 2019-07-28 stsp .Pp
4055 a099809f 2021-08-27 stsp Display changes on the remote repository's version of the
4056 ff2cf171 2019-07-28 stsp .Dq master
4057 a099809f 2021-08-27 stsp branch, as of the last time
4058 a099809f 2021-08-27 stsp .Cm got fetch
4059 a099809f 2021-08-27 stsp was run:
4060 a099809f 2021-08-27 stsp .Pp
4061 a099809f 2021-08-27 stsp .Dl $ got log -c origin/master | less
4062 a099809f 2021-08-27 stsp .Pp
4063 a099809f 2021-08-27 stsp As shown here, most commands accept abbreviated reference names such as
4064 ff2cf171 2019-07-28 stsp .Dq origin/master
4065 a099809f 2021-08-27 stsp instead of
4066 a099809f 2021-08-27 stsp .Dq refs/remotes/origin/master .
4067 a099809f 2021-08-27 stsp The latter is only needed in case of ambiguity.
4068 a099809f 2021-08-27 stsp .Pp
4069 a099809f 2021-08-27 stsp .Cm got rebase
4070 1fa75a87 2023-06-22 thomas can be used to merge changes which are visible on the
4071 a099809f 2021-08-27 stsp .Dq origin/master
4072 a099809f 2021-08-27 stsp branch into the
4073 a099809f 2021-08-27 stsp .Dq master
4074 7b0db533 2020-02-04 stsp branch.
4075 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
4076 ff2cf171 2019-07-28 stsp .Pp
4077 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
4078 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
4079 083957f4 2020-02-24 stsp .Pp
4080 a099809f 2021-08-27 stsp In order to make changes committed to the
4081 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4082 a099809f 2021-08-27 stsp visible on the
4083 a099809f 2021-08-27 stsp .Dq master
4084 a099809f 2021-08-27 stsp branch, the
4085 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4086 1fa75a87 2023-06-22 thomas branch can be rebased onto the
4087 a099809f 2021-08-27 stsp .Dq master
4088 a099809f 2021-08-27 stsp branch:
4089 a099809f 2021-08-27 stsp .Pp
4090 a099809f 2021-08-27 stsp .Dl $ got update -b master
4091 a099809f 2021-08-27 stsp .Dl $ got rebase unified-buffer-cache
4092 a099809f 2021-08-27 stsp .Pp
4093 a099809f 2021-08-27 stsp Changes on the
4094 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4095 a099809f 2021-08-27 stsp branch can now be made visible on the
4096 a099809f 2021-08-27 stsp .Dq master
4097 a099809f 2021-08-27 stsp branch with
4098 a099809f 2021-08-27 stsp .Cm got integrate .
4099 a099809f 2021-08-27 stsp Because the rebase operation switched the work tree to the
4100 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4101 4b06140e 2022-03-22 thomas branch, the work tree must be switched back to the
4102 a099809f 2021-08-27 stsp .Dq master
4103 a099809f 2021-08-27 stsp branch first:
4104 a099809f 2021-08-27 stsp .Pp
4105 a099809f 2021-08-27 stsp .Dl $ got update -b master
4106 a099809f 2021-08-27 stsp .Dl $ got integrate unified-buffer-cache
4107 a099809f 2021-08-27 stsp .Pp
4108 083957f4 2020-02-24 stsp On the
4109 083957f4 2020-02-24 stsp .Dq master
4110 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
4111 083957f4 2020-02-24 stsp .Dq OK
4112 083957f4 2020-02-24 stsp by other developers and any other important new information:
4113 ff2cf171 2019-07-28 stsp .Pp
4114 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
4115 083957f4 2020-02-24 stsp .Dl $ got histedit -m
4116 083957f4 2020-02-24 stsp .Pp
4117 4b06140e 2022-03-22 thomas If the remote repository offers write access, local changes on the
4118 ff2cf171 2019-07-28 stsp .Dq master
4119 a099809f 2021-08-27 stsp branch can be sent to the remote repository with
4120 ac93b2c5 2021-10-08 thomas .Cm got send .
4121 ac93b2c5 2021-10-08 thomas Usually,
4122 a099809f 2021-08-27 stsp .Cm got send
4123 a099809f 2021-08-27 stsp can be run without further arguments.
4124 a099809f 2021-08-27 stsp The arguments shown here match defaults, provided the work tree's
4125 a099809f 2021-08-27 stsp current branch is the
4126 a099809f 2021-08-27 stsp .Dq master
4127 a099809f 2021-08-27 stsp branch:
4128 ff2cf171 2019-07-28 stsp .Pp
4129 a099809f 2021-08-27 stsp .Dl $ got send -b master origin
4130 a099809f 2021-08-27 stsp .Pp
4131 4b06140e 2022-03-22 thomas If the remote repository requires the HTTPS protocol, the
4132 a099809f 2021-08-27 stsp .Xr git-push 1
4133 a099809f 2021-08-27 stsp command must be used instead:
4134 a099809f 2021-08-27 stsp .Pp
4135 a099809f 2021-08-27 stsp .Dl $ cd /var/git/src.git
4136 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
4137 4ff74dcf 2022-07-20 thomas .Pp
4138 4ff74dcf 2022-07-20 thomas When making contributions to projects which use the
4139 4ff74dcf 2022-07-20 thomas .Dq pull request
4140 4ff74dcf 2022-07-20 thomas workflow, SSH protocol repository access needs to be set up first.
4141 4ff74dcf 2022-07-20 thomas Once an account has been created on a Git hosting site it should
4142 4ff74dcf 2022-07-20 thomas be possible to upload a public SSH key for repository access
4143 4ff74dcf 2022-07-20 thomas authentication.
4144 4ff74dcf 2022-07-20 thomas .Pp
4145 4ff74dcf 2022-07-20 thomas The
4146 4ff74dcf 2022-07-20 thomas .Dq pull request
4147 4ff74dcf 2022-07-20 thomas workflow will usually involve two remote repositories.
4148 4ff74dcf 2022-07-20 thomas In the real-life example below, the
4149 4ff74dcf 2022-07-20 thomas .Dq origin
4150 4ff74dcf 2022-07-20 thomas repository was forked from the
4151 4ff74dcf 2022-07-20 thomas .Dq upstream
4152 4ff74dcf 2022-07-20 thomas repository by using the Git hosting site's web interface.
4153 4ff74dcf 2022-07-20 thomas The
4154 4ff74dcf 2022-07-20 thomas .Xr got.conf 5
4155 4ff74dcf 2022-07-20 thomas file in the local repository describes both remote repositories:
4156 4ff74dcf 2022-07-20 thomas .Bd -literal -offset indent
4157 4ff74dcf 2022-07-20 thomas # Jelmers's repository, which accepts pull requests
4158 4ff74dcf 2022-07-20 thomas remote "upstream" {
4159 4ff74dcf 2022-07-20 thomas server git@github.com
4160 4ff74dcf 2022-07-20 thomas protocol ssh
4161 4ff74dcf 2022-07-20 thomas repository "/jelmer/dulwich"
4162 4ff74dcf 2022-07-20 thomas branch { "master" }
4163 4ff74dcf 2022-07-20 thomas }
4164 4ff74dcf 2022-07-20 thomas
4165 4ff74dcf 2022-07-20 thomas # Stefan's fork, used as the default remote repository
4166 4ff74dcf 2022-07-20 thomas remote "origin" {
4167 4ff74dcf 2022-07-20 thomas server git@github.com
4168 4ff74dcf 2022-07-20 thomas protocol ssh
4169 4ff74dcf 2022-07-20 thomas repository "/stspdotname/dulwich"
4170 4ff74dcf 2022-07-20 thomas branch { "master" }
4171 4ff74dcf 2022-07-20 thomas }
4172 4ff74dcf 2022-07-20 thomas .Ed
4173 4ff74dcf 2022-07-20 thomas .Pp
4174 4ff74dcf 2022-07-20 thomas With this configuration, Stefan can create commits on
4175 4ff74dcf 2022-07-20 thomas .Dq refs/heads/master
4176 4ff74dcf 2022-07-20 thomas and send them to the
4177 4ff74dcf 2022-07-20 thomas .Dq origin
4178 4ff74dcf 2022-07-20 thomas repository by running:
4179 4ff74dcf 2022-07-20 thomas .Pp
4180 4ff74dcf 2022-07-20 thomas .Dl $ got send -b master origin
4181 4ff74dcf 2022-07-20 thomas .Pp
4182 4ff74dcf 2022-07-20 thomas The changes can now be proposed to Jelmer by opening a pull request
4183 4ff74dcf 2022-07-20 thomas via the Git hosting site's web interface.
4184 4ff74dcf 2022-07-20 thomas If Jelmer requests further changes to be made, additional commits
4185 4ff74dcf 2022-07-20 thomas can be created on the
4186 4ff74dcf 2022-07-20 thomas .Dq master
4187 4ff74dcf 2022-07-20 thomas branch and be added to the pull request by running
4188 4ff74dcf 2022-07-20 thomas .Cd got send
4189 4ff74dcf 2022-07-20 thomas again.
4190 4ff74dcf 2022-07-20 thomas .Pp
4191 4ff74dcf 2022-07-20 thomas If Jelmer prefers additional commits to be
4192 4ff74dcf 2022-07-20 thomas .Dq squashed
4193 4ff74dcf 2022-07-20 thomas then the following commands can be used to achieve this:
4194 4ff74dcf 2022-07-20 thomas .Pp
4195 4ff74dcf 2022-07-20 thomas .Dl $ got update -b master
4196 4ff74dcf 2022-07-20 thomas .Dl $ got update -c origin/master
4197 4ff74dcf 2022-07-20 thomas .Dl $ got histedit -f
4198 4ff74dcf 2022-07-20 thomas .Dl $ got send -f -b master origin
4199 4ff74dcf 2022-07-20 thomas .Pp
4200 f2afb89d 2023-04-22 thomas In addition to reviewing the pull request in the web user interface,
4201 f2afb89d 2023-04-22 thomas Jelmer can fetch the pull request's branch into his local repository
4202 f2afb89d 2023-04-22 thomas and create a local branch which contains the proposed changes:
4203 f2afb89d 2023-04-22 thomas .Pp
4204 f2afb89d 2023-04-22 thomas .Dl $ got fetch -R refs/pull/1046/head origin
4205 f2afb89d 2023-04-22 thomas .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4206 f2afb89d 2023-04-22 thomas .Pp
4207 4ff74dcf 2022-07-20 thomas Once Jelmer has accepted the pull request, Stefan can fetch the
4208 4ff74dcf 2022-07-20 thomas merged changes, and possibly several other new changes, by running:
4209 4ff74dcf 2022-07-20 thomas .Pp
4210 4ff74dcf 2022-07-20 thomas .Dl $ got fetch upstream
4211 4ff74dcf 2022-07-20 thomas .Pp
4212 4ff74dcf 2022-07-20 thomas The merged changes will now be visible under the reference
4213 4ff74dcf 2022-07-20 thomas .Dq refs/remotes/upstream/master .
4214 4ff74dcf 2022-07-20 thomas The local
4215 4ff74dcf 2022-07-20 thomas .Dq master
4216 4ff74dcf 2022-07-20 thomas branch can now be rebased on top of the latest changes
4217 4ff74dcf 2022-07-20 thomas from upstream:
4218 4ff74dcf 2022-07-20 thomas .Pp
4219 4ff74dcf 2022-07-20 thomas .Dl $ got update -b upstream/master
4220 4ff74dcf 2022-07-20 thomas .Dl $ got rebase master
4221 0b83b8f6 2023-06-22 thomas .Pp
4222 0b83b8f6 2023-06-22 thomas As an alternative to
4223 0b83b8f6 2023-06-22 thomas .Cm got rebase ,
4224 0b83b8f6 2023-06-22 thomas branches can be merged with
4225 0b83b8f6 2023-06-22 thomas .Cm got merge :
4226 0b83b8f6 2023-06-22 thomas .Pp
4227 0b83b8f6 2023-06-22 thomas .Dl $ got update -b master
4228 0b83b8f6 2023-06-22 thomas .Dl $ got merge upstream/master
4229 4ff74dcf 2022-07-20 thomas .Pp
4230 0b83b8f6 2023-06-22 thomas The question of whether to rebase or merge branches is philosophical.
4231 0b83b8f6 2023-06-22 thomas When in doubt, refer to the software project's policies set by project
4232 0b83b8f6 2023-06-22 thomas maintainers.
4233 0b83b8f6 2023-06-22 thomas .Pp
4234 4ff74dcf 2022-07-20 thomas As a final step, the forked repository's copy of the master branch needs
4235 4ff74dcf 2022-07-20 thomas to be kept in sync by sending the new changes there:
4236 4ff74dcf 2022-07-20 thomas .Pp
4237 4ff74dcf 2022-07-20 thomas .Dl $ got send -f -b master origin
4238 4ff74dcf 2022-07-20 thomas .Pp
4239 4ff74dcf 2022-07-20 thomas If multiple pull requests need to be managed in parallel, a separate branch
4240 4ff74dcf 2022-07-20 thomas must be created for each pull request with
4241 4ff74dcf 2022-07-20 thomas .Cm got branch .
4242 4ff74dcf 2022-07-20 thomas Each such branch can then be used as above, in place of
4243 4ff74dcf 2022-07-20 thomas .Dq refs/heads/master .
4244 4ff74dcf 2022-07-20 thomas Changes for any accepted pull requests will still appear under
4245 4ff74dcf 2022-07-20 thomas .Dq refs/remotes/upstream/master,
4246 4ff74dcf 2022-07-20 thomas regardless of which branch was used in the forked repository to
4247 4ff74dcf 2022-07-20 thomas create a pull request.
4248 5c860e29 2018-03-12 stsp .Sh SEE ALSO
4249 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
4250 2312fc47 2019-07-15 stsp .Xr tog 1 ,
4251 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
4252 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
4253 b345cf8f 2022-07-05 thomas .Xr got.conf 5 ,
4254 85c360aa 2023-01-02 thomas .Xr gotwebd 8
4255 1a208aaf 2018-04-01 stsp .Sh AUTHORS
4256 60c73080 2022-07-05 thomas .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4257 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
4258 60c73080 2022-07-05 thomas .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4259 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
4260 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
4261 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
4262 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
4263 f6fad9f6 2022-07-05 thomas .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4264 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
4265 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
4266 60c73080 2022-07-05 thomas .An Sebastien Marie Aq Mt semarie@openbsd.org
4267 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
4268 bee5044f 2022-07-05 thomas .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4269 60c73080 2022-07-05 thomas .An Theo Buehler Aq Mt tb@openbsd.org
4270 60c73080 2022-07-05 thomas .An Thomas Adam Aq Mt thomas@xteddy.org
4271 60c73080 2022-07-05 thomas .An Tracey Emery Aq Mt tracey@traceyemery.net
4272 60c73080 2022-07-05 thomas .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4273 de71b616 2022-07-05 thomas .Pp
4274 de71b616 2022-07-05 thomas Parts of
4275 de71b616 2022-07-05 thomas .Nm ,
4276 de71b616 2022-07-05 thomas .Xr tog 1 ,
4277 de71b616 2022-07-05 thomas and
4278 85c360aa 2023-01-02 thomas .Xr gotwebd 8
4279 de71b616 2022-07-05 thomas were derived from code under copyright by:
4280 de71b616 2022-07-05 thomas .Pp
4281 408db73d 2022-07-22 thomas .An Caldera International
4282 de71b616 2022-07-05 thomas .An Daniel Hartmeier
4283 de71b616 2022-07-05 thomas .An Esben Norby
4284 de71b616 2022-07-05 thomas .An Henning Brauer
4285 de71b616 2022-07-05 thomas .An HÃ¥kan Olsson
4286 de71b616 2022-07-05 thomas .An Ingo Schwarze
4287 de71b616 2022-07-05 thomas .An Jean-Francois Brousseau
4288 de71b616 2022-07-05 thomas .An Joris Vink
4289 de71b616 2022-07-05 thomas .An Jyri J. Virkki
4290 de71b616 2022-07-05 thomas .An Larry Wall
4291 408db73d 2022-07-22 thomas .An Markus Friedl
4292 de71b616 2022-07-05 thomas .An Niall O'Higgins
4293 de71b616 2022-07-05 thomas .An Niklas Hallqvist
4294 de71b616 2022-07-05 thomas .An Ray Lai
4295 de71b616 2022-07-05 thomas .An Ryan McBride
4296 de71b616 2022-07-05 thomas .An Theo de Raadt
4297 de71b616 2022-07-05 thomas .An Todd C. Miller
4298 de71b616 2022-07-05 thomas .An Xavier Santolaria
4299 e4badaa9 2022-07-05 thomas .Pp
4300 e4badaa9 2022-07-05 thomas .Nm
4301 e4badaa9 2022-07-05 thomas contains code contributed to the public domain by
4302 86f8a176 2022-12-30 thomas .An Austin Appleby .
4303 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
4304 fa6e0e48 2019-05-23 stsp .Nm
4305 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
4306 1795b260 2021-04-02 kn .Pp
4307 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
4308 fa6e0e48 2019-05-23 stsp .Xr git 1
4309 cc63216e 2020-12-26 stsp to perform some tasks.
4310 cc63216e 2020-12-26 stsp In particular:
4311 cc63216e 2020-12-26 stsp .Bl -bullet
4312 cc63216e 2020-12-26 stsp .It
4313 a099809f 2021-08-27 stsp Writing to remote repositories over HTTP or HTTPS protocols requires
4314 cc63216e 2020-12-26 stsp .Xr git-push 1 .
4315 cc63216e 2020-12-26 stsp .It
4316 22a38a43 2021-09-28 thomas The creation of merge commits with more than two parent commits requires
4317 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
4318 cc63216e 2020-12-26 stsp .It
4319 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
4320 cc63216e 2020-12-26 stsp .Cm got
4321 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
4322 cc63216e 2020-12-26 stsp .Xr git 1
4323 cc63216e 2020-12-26 stsp will usually produce better results.
4324 cc63216e 2020-12-26 stsp .El