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