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