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