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