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