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