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 09ea71ba 2019-07-27 stsp .It Cm init Ar repository-path
66 2c7829a4 2019-06-17 stsp Create a new empty repository at the specified
67 09ea71ba 2019-07-27 stsp .Ar repository-path .
68 3ce1b845 2019-07-15 stsp .Pp
69 3ce1b845 2019-07-15 stsp After
70 3ce1b845 2019-07-15 stsp .Cm got init ,
71 3ce1b845 2019-07-15 stsp the
72 3ce1b845 2019-07-15 stsp .Cm got import
73 3ce1b845 2019-07-15 stsp command must be used to populate the empty repository before
74 3ce1b845 2019-07-15 stsp .Cm got checkout
75 3ce1b845 2019-07-15 stsp can be used.
76 dfc23429 2019-08-11 stsp .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
77 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
78 3ce1b845 2019-07-15 stsp within the specified
79 3ce1b845 2019-07-15 stsp .Ar directory .
80 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
81 3ce1b845 2019-07-15 stsp root commit.
82 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
83 3ce1b845 2019-07-15 stsp created commit.
84 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
85 3ce1b845 2019-07-15 stsp .Pp
86 21a44f98 2019-07-15 stsp The
87 21a44f98 2019-07-15 stsp .Cm got import
88 21a44f98 2019-07-15 stsp command requires the
89 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
90 aba9c984 2019-09-08 stsp environment variable to be set,
91 257add31 2020-09-09 stsp unless an author has been configured in
92 257add31 2020-09-09 stsp .Xr got.conf 5
93 257add31 2020-09-09 stsp or Git's
94 aba9c984 2019-09-08 stsp .Dv user.name
95 aba9c984 2019-09-08 stsp and
96 709ae9eb 2019-09-08 stsp .Dv user.email
97 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
98 aba9c984 2019-09-08 stsp .Pa .git/config
99 c9956ddf 2019-09-08 stsp file or from Git's global
100 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
101 c9956ddf 2019-09-08 stsp configuration file.
102 3ce1b845 2019-07-15 stsp .Pp
103 3ce1b845 2019-07-15 stsp The options for
104 3ce1b845 2019-07-15 stsp .Cm got import
105 3ce1b845 2019-07-15 stsp are as follows:
106 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
107 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
108 3ce1b845 2019-07-15 stsp Create the specified
109 3ce1b845 2019-07-15 stsp .Ar branch
110 3ce1b845 2019-07-15 stsp instead of creating the default branch
111 5d67f40d 2019-11-08 stsp .Dq main .
112 3ce1b845 2019-07-15 stsp Use of this option is required if the
113 5d67f40d 2019-11-08 stsp .Dq main
114 3ce1b845 2019-07-15 stsp branch already exists.
115 3ce1b845 2019-07-15 stsp .It Fl m Ar message
116 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
117 3ce1b845 2019-07-15 stsp Without the
118 3ce1b845 2019-07-15 stsp .Fl m
119 3ce1b845 2019-07-15 stsp option,
120 3ce1b845 2019-07-15 stsp .Cm got import
121 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
122 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
123 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
124 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
125 3ce1b845 2019-07-15 stsp working directory.
126 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
127 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
128 3ce1b845 2019-07-15 stsp .Ar pattern .
129 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
130 3ce1b845 2019-07-15 stsp The
131 3ce1b845 2019-07-15 stsp .Ar pattern
132 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
133 3ce1b845 2019-07-15 stsp .Xr glob 7 .
134 3ce1b845 2019-07-15 stsp .El
135 bc26cce8 2019-08-04 stsp .It Cm im
136 bc26cce8 2019-08-04 stsp Short alias for
137 bc26cce8 2019-08-04 stsp .Cm import .
138 0e4002ca 2020-03-21 stsp .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl m Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Ar repository-URL Op Ar directory
139 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
140 2ab43947 2020-03-18 stsp .Ar repository-URL
141 2ab43947 2020-03-18 stsp into the specified
142 3493b628 2020-03-20 stsp .Ar directory .
143 2ab43947 2020-03-18 stsp If no
144 3493b628 2020-03-20 stsp .Ar directory
145 2ab43947 2020-03-18 stsp is specified the directory name will be derived from the name of the
146 2ab43947 2020-03-18 stsp cloned repository.
147 2ab43947 2020-03-18 stsp .Cm got clone
148 2ab43947 2020-03-18 stsp will refuse to run if the
149 3493b628 2020-03-20 stsp .Ar directory
150 2ab43947 2020-03-18 stsp already exists.
151 2ab43947 2020-03-18 stsp .Pp
152 2ab43947 2020-03-18 stsp The
153 2ab43947 2020-03-18 stsp .Ar repository-URL
154 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
155 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
156 619eb6dd 2020-03-20 stsp the server:
157 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
158 2ab43947 2020-03-18 stsp .Pp
159 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
160 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
161 2ab43947 2020-03-18 stsp .It git
162 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
163 2ab43947 2020-03-18 stsp .Xr git-daemon 1
164 2ab43947 2020-03-18 stsp server.
165 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
166 10c073e7 2020-03-20 stsp nor encryption.
167 2ab43947 2020-03-18 stsp .It git+ssh
168 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
169 2ab43947 2020-03-18 stsp .Xr ssh 1
170 2ab43947 2020-03-18 stsp tunnel.
171 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
172 2ab43947 2020-03-18 stsp .Xr ssh 1
173 2ab43947 2020-03-18 stsp to use:
174 2ab43947 2020-03-18 stsp .Mt user@hostname
175 2ab43947 2020-03-18 stsp .It ssh
176 2ab43947 2020-03-18 stsp Short alias for git+ssh.
177 2ab43947 2020-03-18 stsp .El
178 89c3c67b 2020-03-20 stsp .Pp
179 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
180 89c3c67b 2020-03-20 stsp from the server.
181 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
182 89c3c67b 2020-03-20 stsp within.
183 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
184 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
185 89c3c67b 2020-03-20 stsp This can take some time.
186 010f7279 2020-03-20 stsp More details about the pack file format are documented in
187 010f7279 2020-03-20 stsp .Xr git-repository 5 .
188 2ab43947 2020-03-18 stsp .Pp
189 7848a0e1 2020-03-19 stsp .Cm got clone
190 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
191 257add31 2020-09-09 stsp .Xr got.conf 5
192 257add31 2020-09-09 stsp and
193 7848a0e1 2020-03-19 stsp .Pa config
194 257add31 2020-09-09 stsp files of the cloned repository to store the
195 7848a0e1 2020-03-19 stsp .Ar repository-url
196 99495ddb 2021-01-10 stsp and any
197 15d3c221 2021-01-05 stsp .Ar branch
198 99495ddb 2021-01-10 stsp or
199 99495ddb 2021-01-10 stsp .Ar reference
200 132af4a5 2021-01-05 stsp arguments for future use by
201 7848a0e1 2020-03-19 stsp .Cm got fetch
202 fc24bb3a 2020-03-21 stsp or
203 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
204 7848a0e1 2020-03-19 stsp .Pp
205 2ab43947 2020-03-18 stsp The options for
206 2ab43947 2020-03-18 stsp .Cm got clone
207 2ab43947 2020-03-18 stsp are as follows:
208 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
209 659e7fbd 2020-03-20 stsp .It Fl a
210 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
211 1d4b192f 2020-03-21 stsp .Dq refs/heads/
212 5aa20203 2021-01-05 stsp reference namespace and set
213 5aa20203 2021-01-05 stsp .Cm fetch-all-branches
214 5aa20203 2021-01-05 stsp in the cloned repository's
215 5aa20203 2021-01-05 stsp .Xr got.conf 5
216 5aa20203 2021-01-05 stsp file for future use by
217 5aa20203 2021-01-05 stsp .Cm got fetch .
218 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
219 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
220 4ba14133 2020-03-20 stsp Cannot be used together with the
221 4ba14133 2020-03-20 stsp .Fl b
222 4ba14133 2020-03-20 stsp option.
223 4ba14133 2020-03-20 stsp .It Fl b Ar branch
224 4ba14133 2020-03-20 stsp Fetch the specified
225 4ba14133 2020-03-20 stsp .Ar branch
226 1d4b192f 2020-03-21 stsp from the remote repository's
227 1d4b192f 2020-03-21 stsp .Dq refs/heads/
228 1d4b192f 2020-03-21 stsp reference namespace.
229 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
230 4ba14133 2020-03-20 stsp to fetch.
231 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
232 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
233 4ba14133 2020-03-20 stsp branch which was fetched.
234 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
235 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
236 4ba14133 2020-03-20 stsp Cannot be used together with the
237 4ba14133 2020-03-20 stsp .Fl a
238 4ba14133 2020-03-20 stsp option.
239 41b0de12 2020-03-21 stsp .It Fl l
240 a18cccf9 2020-03-21 stsp List branches and tags available for fetching from the remote repository
241 41b0de12 2020-03-21 stsp and exit immediately.
242 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
243 a5a46be2 2021-01-27 stsp .Fl q
244 a5a46be2 2021-01-27 stsp and
245 41b0de12 2020-03-21 stsp .Fl v .
246 469dd726 2020-03-20 stsp .It Fl m
247 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
248 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
249 bd81cfb7 2020-04-19 stsp locally created commits.
250 469dd726 2020-03-20 stsp .Pp
251 469dd726 2020-03-20 stsp The repository's
252 257add31 2020-09-09 stsp .Xr got.conf 5
253 257add31 2020-09-09 stsp and
254 469dd726 2020-03-20 stsp .Pa config
255 257add31 2020-09-09 stsp files will be set up with the
256 469dd726 2020-03-20 stsp .Dq mirror
257 469dd726 2020-03-20 stsp option enabled, such that
258 469dd726 2020-03-20 stsp .Cm got fetch
259 469dd726 2020-03-20 stsp or
260 469dd726 2020-03-20 stsp .Xr git-fetch 1
261 bd81cfb7 2020-04-19 stsp will write incoming changes directly to branches in the
262 469dd726 2020-03-20 stsp .Dq refs/heads/
263 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
264 469dd726 2020-03-20 stsp .Dq refs/remotes/
265 469dd726 2020-03-20 stsp namespace.
266 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
267 469dd726 2020-03-20 stsp .Cm got rebase
268 469dd726 2020-03-20 stsp after
269 469dd726 2020-03-20 stsp .Cm got fetch
270 bd81cfb7 2020-04-19 stsp in order to make incoming changes appear on branches in the
271 bd81cfb7 2020-04-19 stsp .Dq refs/heads/
272 bd81cfb7 2020-04-19 stsp namespace.
273 bd81cfb7 2020-04-19 stsp But maintaining custom changes in the cloned repository becomes difficult
274 bd81cfb7 2020-04-19 stsp since such changes will be at risk of being discarded whenever incoming
275 498ef124 2020-03-21 stsp changes are fetched.
276 2ab43947 2020-03-18 stsp .It Fl q
277 2ab43947 2020-03-18 stsp Suppress progress reporting output.
278 2ab43947 2020-03-18 stsp The same option will be passed to
279 2ab43947 2020-03-18 stsp .Xr ssh 1
280 2ab43947 2020-03-18 stsp if applicable.
281 2ab43947 2020-03-18 stsp .It Fl v
282 2690194b 2020-03-21 stsp Verbose mode.
283 2690194b 2020-03-21 stsp Causes
284 2690194b 2020-03-21 stsp .Cm got clone
285 2690194b 2020-03-21 stsp to print debugging messages to standard error output.
286 2690194b 2020-03-21 stsp This option will be passed to
287 2ab43947 2020-03-18 stsp .Xr ssh 1
288 2ab43947 2020-03-18 stsp if applicable.
289 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
290 2ab43947 2020-03-18 stsp The maximum is 3.
291 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
292 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
293 0e4002ca 2020-03-21 stsp .Ar reference
294 0e4002ca 2020-03-21 stsp from the remote repository's
295 0e4002ca 2020-03-21 stsp .Dq refs/
296 0e4002ca 2020-03-21 stsp namespace.
297 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
298 0e4002ca 2020-03-21 stsp references to fetch.
299 71f12362 2020-03-21 stsp The specified
300 71f12362 2020-03-21 stsp .Ar reference
301 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
302 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
303 0e4002ca 2020-03-21 stsp .Pp
304 71f12362 2020-03-21 stsp Each reference will be mapped into the cloned repository's
305 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
306 0e4002ca 2020-03-21 stsp namespace, unless the
307 0e4002ca 2020-03-21 stsp .Fl m
308 0e4002ca 2020-03-21 stsp option is used to mirror references directly into the cloned repository's
309 0e4002ca 2020-03-21 stsp .Dq refs/
310 0e4002ca 2020-03-21 stsp namespace.
311 0e4002ca 2020-03-21 stsp .Pp
312 0e4002ca 2020-03-21 stsp .Cm got clone
313 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
314 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
315 0e4002ca 2020-03-21 stsp or
316 0e4002ca 2020-03-21 stsp .Dq refs/got/
317 0e4002ca 2020-03-21 stsp namespace.
318 2ab43947 2020-03-18 stsp .El
319 267fe567 2020-03-18 stsp .It Cm cl
320 267fe567 2020-03-18 stsp Short alias for
321 267fe567 2020-03-18 stsp .Cm clone .
322 161728eb 2021-07-24 stsp .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl t Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Oo Fl X Oc Op Ar remote-repository
323 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
324 7848a0e1 2020-03-19 stsp If no
325 4ba14133 2020-03-20 stsp .Ar remote-repository
326 4ba14133 2020-03-20 stsp is specified,
327 7848a0e1 2020-03-19 stsp .Dq origin
328 7848a0e1 2020-03-19 stsp will be used.
329 50b0790e 2020-09-11 stsp The remote repository's URL is obtained from the corresponding entry in
330 257add31 2020-09-09 stsp .Xr got.conf 5
331 50b0790e 2020-09-11 stsp or Git's
332 7848a0e1 2020-03-19 stsp .Pa config
333 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
334 7848a0e1 2020-03-19 stsp .Cm got clone .
335 7848a0e1 2020-03-19 stsp .Pp
336 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
337 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
338 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
339 89c3c67b 2020-03-20 stsp .Pp
340 498ef124 2020-03-21 stsp By default, branch references in the
341 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
342 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
343 498ef124 2020-03-21 stsp The
344 498ef124 2020-03-21 stsp .Cm got rebase
345 bd81cfb7 2020-04-19 stsp command can then be used to make new changes visible on branches in the
346 7848a0e1 2020-03-19 stsp .Dq refs/heads/
347 bd81cfb7 2020-04-19 stsp namespace, merging incoming changes with the changes on those branches
348 bd81cfb7 2020-04-19 stsp as necessary.
349 7848a0e1 2020-03-19 stsp .Pp
350 498ef124 2020-03-21 stsp If the repository was created as a mirror with
351 498ef124 2020-03-21 stsp .Cm got clone -m
352 498ef124 2020-03-21 stsp then all branches in the
353 469dd726 2020-03-20 stsp .Dq refs/heads/
354 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
355 498ef124 2020-03-21 stsp the remote repository.
356 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
357 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
358 e6786710 2021-07-03 stsp by Git's garbage collector or
359 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
360 bd81cfb7 2020-04-19 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
361 469dd726 2020-03-20 stsp .Pp
362 db6d8ad8 2020-03-21 stsp In any case, references in the
363 7848a0e1 2020-03-19 stsp .Dq refs/tags/
364 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
365 db6d8ad8 2020-03-21 stsp in the same namespace.
366 7848a0e1 2020-03-19 stsp .Pp
367 7848a0e1 2020-03-19 stsp The options for
368 7848a0e1 2020-03-19 stsp .Cm got fetch
369 7848a0e1 2020-03-19 stsp are as follows:
370 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
371 659e7fbd 2020-03-20 stsp .It Fl a
372 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
373 1d4b192f 2020-03-21 stsp .Dq refs/heads/
374 1d4b192f 2020-03-21 stsp reference namespace.
375 0c8b29c5 2021-01-05 stsp This option can be enabled by default for specific repositories in
376 0c8b29c5 2021-01-05 stsp .Xr got.conf 5 .
377 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
378 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
379 4ba14133 2020-03-20 stsp Cannot be used together with the
380 4ba14133 2020-03-20 stsp .Fl b
381 4ba14133 2020-03-20 stsp option.
382 4ba14133 2020-03-20 stsp .It Fl b Ar branch
383 4ba14133 2020-03-20 stsp Fetch the specified
384 4ba14133 2020-03-20 stsp .Ar branch
385 1d4b192f 2020-03-21 stsp from the remote repository's
386 1d4b192f 2020-03-21 stsp .Dq refs/heads/
387 1d4b192f 2020-03-21 stsp reference namespace.
388 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
389 4ba14133 2020-03-20 stsp to fetch.
390 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
391 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
392 4ba14133 2020-03-20 stsp Cannot be used together with the
393 4ba14133 2020-03-20 stsp .Fl a
394 4ba14133 2020-03-20 stsp option.
395 f21ec2f0 2020-03-21 stsp .It Fl d
396 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
397 f21ec2f0 2020-03-21 stsp present in the remote repository.
398 f21ec2f0 2020-03-21 stsp Only references are deleted.
399 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
400 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
401 e6786710 2021-07-03 stsp Git's garbage collector or
402 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
403 41b0de12 2020-03-21 stsp .It Fl l
404 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
405 41b0de12 2020-03-21 stsp and exit immediately.
406 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
407 612392ee 2021-01-05 stsp .Fl v ,
408 612392ee 2021-01-05 stsp .Fl q ,
409 41b0de12 2020-03-21 stsp and
410 41b0de12 2020-03-21 stsp .Fl r .
411 db6d8ad8 2020-03-21 stsp .It Fl t
412 db6d8ad8 2020-03-21 stsp Allow existing references in the
413 db6d8ad8 2020-03-21 stsp .Dq refs/tags
414 db6d8ad8 2020-03-21 stsp namespace to be updated if they have changed on the server.
415 db6d8ad8 2020-03-21 stsp If not specified, only new tag references will be created.
416 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
417 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
418 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
419 7848a0e1 2020-03-19 stsp working directory.
420 7848a0e1 2020-03-19 stsp If this directory is a
421 7848a0e1 2020-03-19 stsp .Nm
422 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
423 7848a0e1 2020-03-19 stsp .It Fl q
424 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
425 7848a0e1 2020-03-19 stsp The same option will be passed to
426 7848a0e1 2020-03-19 stsp .Xr ssh 1
427 7848a0e1 2020-03-19 stsp if applicable.
428 7848a0e1 2020-03-19 stsp .It Fl v
429 2690194b 2020-03-21 stsp Verbose mode.
430 2690194b 2020-03-21 stsp Causes
431 2690194b 2020-03-21 stsp .Cm got fetch
432 2690194b 2020-03-21 stsp to print debugging messages to standard error output.
433 7848a0e1 2020-03-19 stsp The same option will be passed to
434 7848a0e1 2020-03-19 stsp .Xr ssh 1
435 7848a0e1 2020-03-19 stsp if applicable.
436 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
437 7848a0e1 2020-03-19 stsp The maximum is 3.
438 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
439 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
440 0e4002ca 2020-03-21 stsp .Ar reference
441 0e4002ca 2020-03-21 stsp from the remote repository's
442 0e4002ca 2020-03-21 stsp .Dq refs/
443 0e4002ca 2020-03-21 stsp namespace.
444 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
445 0e4002ca 2020-03-21 stsp references to fetch.
446 71f12362 2020-03-21 stsp The specified
447 71f12362 2020-03-21 stsp .Ar reference
448 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
449 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
450 0e4002ca 2020-03-21 stsp .Pp
451 0e4002ca 2020-03-21 stsp Each reference will be mapped into the local repository's
452 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
453 0e4002ca 2020-03-21 stsp namespace, unless the local repository was created as a mirror with
454 a18cccf9 2020-03-21 stsp .Cm got clone -m
455 a18cccf9 2020-03-21 stsp in which case references will be mapped directly into the local repository's
456 a18cccf9 2020-03-21 stsp .Dq refs/
457 a18cccf9 2020-03-21 stsp namespace.
458 a18cccf9 2020-03-21 stsp .Pp
459 bd81cfb7 2020-04-19 stsp Once a reference has been fetched, a branch based on it can be created with
460 0e4002ca 2020-03-21 stsp .Cm got branch
461 0e4002ca 2020-03-21 stsp if needed.
462 0e4002ca 2020-03-21 stsp .Pp
463 0e4002ca 2020-03-21 stsp .Cm got fetch
464 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
465 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
466 0e4002ca 2020-03-21 stsp or
467 0e4002ca 2020-03-21 stsp .Dq refs/got/
468 0e4002ca 2020-03-21 stsp namespace.
469 161728eb 2021-07-24 stsp .It Fl X
470 161728eb 2021-07-24 stsp Delete all references which correspond to a particular
471 161728eb 2021-07-24 stsp .Ar remote-repository
472 161728eb 2021-07-24 stsp instead of fetching new changes.
473 161728eb 2021-07-24 stsp This can be useful when a remote repository is being removed from
474 161728eb 2021-07-24 stsp .Xr got.conf 5 .
475 161728eb 2021-07-24 stsp .Pp
476 161728eb 2021-07-24 stsp With
477 161728eb 2021-07-24 stsp .Fl X ,
478 161728eb 2021-07-24 stsp the
479 161728eb 2021-07-24 stsp .Ar remote-repository
480 161728eb 2021-07-24 stsp argument is mandatory and no other options except
481 161728eb 2021-07-24 stsp .Fl r ,
482 161728eb 2021-07-24 stsp .Fl v ,
483 161728eb 2021-07-24 stsp and
484 161728eb 2021-07-24 stsp .Fl q
485 161728eb 2021-07-24 stsp are allowed.
486 161728eb 2021-07-24 stsp .Pp
487 161728eb 2021-07-24 stsp Only references are deleted.
488 161728eb 2021-07-24 stsp Any commit, tree, tag, and blob objects fetched from a remote repository
489 161728eb 2021-07-24 stsp will generally be stored in pack files and may be removed separately with
490 161728eb 2021-07-24 stsp .Xr git-repack 1
491 161728eb 2021-07-24 stsp and Git's garbage collector.
492 7848a0e1 2020-03-19 stsp .El
493 7848a0e1 2020-03-19 stsp .It Cm fe
494 7848a0e1 2020-03-19 stsp Short alias for
495 7848a0e1 2020-03-19 stsp .Cm fetch .
496 74daf7cb 2020-01-27 stsp .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
497 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
498 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
499 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
500 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
501 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
502 bb51a5b4 2020-01-13 stsp .El
503 bb51a5b4 2020-01-13 stsp .Pp
504 5d7c1dab 2018-04-01 stsp If the
505 5d7c1dab 2018-04-01 stsp .Ar work tree path
506 c844a238 2019-02-06 stsp is not specified, either use the last component of
507 5d7c1dab 2018-04-01 stsp .Ar repository path ,
508 5d7c1dab 2018-04-01 stsp or if a
509 5d7c1dab 2018-04-01 stsp .Ar path prefix
510 c844a238 2019-02-06 stsp was specified use the last component of
511 5d7c1dab 2018-04-01 stsp .Ar path prefix .
512 38e11793 2018-06-13 stsp .Pp
513 38e11793 2018-06-13 stsp The options for
514 38e11793 2018-06-13 stsp .Cm got checkout
515 38e11793 2018-06-13 stsp are as follows:
516 38e11793 2018-06-13 stsp .Bl -tag -width Ds
517 bb51a5b4 2020-01-13 stsp .It Fl E
518 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
519 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
520 bb51a5b4 2020-01-13 stsp is not empty.
521 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
522 08573d5b 2019-05-14 stsp .It Fl b Ar branch
523 3c575567 2019-07-28 stsp Check out files from a commit on the specified
524 08573d5b 2019-05-14 stsp .Ar branch .
525 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
526 08573d5b 2019-05-14 stsp reference will be used.
527 8069f636 2019-01-12 stsp .It Fl c Ar commit
528 8069f636 2019-01-12 stsp Check out files from the specified
529 3c575567 2019-07-28 stsp .Ar commit
530 3c575567 2019-07-28 stsp on the selected branch.
531 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
532 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
533 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
534 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
535 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
536 08573d5b 2019-05-14 stsp branch will be used.
537 4b6c9460 2020-03-05 stsp .Pp
538 4b6c9460 2020-03-05 stsp If the specified
539 4b6c9460 2020-03-05 stsp .Ar commit
540 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
541 4b6c9460 2020-03-05 stsp this commit must be specified with the
542 4b6c9460 2020-03-05 stsp .Fl b
543 4b6c9460 2020-03-05 stsp option.
544 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
545 4b6c9460 2020-03-05 stsp commit with
546 4b6c9460 2020-03-05 stsp .Cm got branch
547 4b6c9460 2020-03-05 stsp before
548 4b6c9460 2020-03-05 stsp .Cm got checkout
549 4b6c9460 2020-03-05 stsp can be used.
550 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
551 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
552 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
553 38e11793 2018-06-13 stsp Only files beneath the specified
554 38e11793 2018-06-13 stsp .Ar path-prefix
555 38e11793 2018-06-13 stsp will be checked out.
556 38e11793 2018-06-13 stsp .El
557 97b3a7be 2019-07-09 stsp .It Cm co
558 97b3a7be 2019-07-09 stsp Short alias for
559 97b3a7be 2019-07-09 stsp .Cm checkout .
560 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
561 4f331d3a 2020-04-01 stsp Update an existing work tree to a different
562 4f331d3a 2020-04-01 stsp .Ar commit .
563 4f331d3a 2020-04-01 stsp Change existing files in the work tree as necessary to match file contents
564 4f331d3a 2020-04-01 stsp of this commit.
565 4f331d3a 2020-04-01 stsp Preserve any local changes in the work tree and merge them with the
566 4f331d3a 2020-04-01 stsp incoming changes.
567 4f331d3a 2020-04-01 stsp .Pp
568 5036ab18 2020-04-18 stsp Files which already contain merge conflicts will not be updated to avoid
569 5036ab18 2020-04-18 stsp further complications.
570 5036ab18 2020-04-18 stsp Such files will be updated when
571 5036ab18 2020-04-18 stsp .Cm got update
572 5036ab18 2020-04-18 stsp is run again after merge conflicts have been resolved.
573 5036ab18 2020-04-18 stsp If the conflicting changes are no longer needed affected files can be
574 5036ab18 2020-04-18 stsp reverted with
575 5036ab18 2020-04-18 stsp .Cm got revert
576 5036ab18 2020-04-18 stsp before running
577 5036ab18 2020-04-18 stsp .Cm got update
578 5036ab18 2020-04-18 stsp again.
579 5036ab18 2020-04-18 stsp .Pp
580 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
581 7f838b36 2019-02-08 stsp .Bl -column YXZ description
582 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
583 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
584 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
585 7f838b36 2019-02-08 stsp .It D Ta file was deleted
586 7f838b36 2019-02-08 stsp .It A Ta new file was added
587 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
588 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
589 5036ab18 2020-04-18 stsp .It # Ta file was not updated because it contains merge conflicts
590 3b9f0f87 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
591 7f838b36 2019-02-08 stsp .El
592 7f838b36 2019-02-08 stsp .Pp
593 f2ea84fa 2019-07-27 stsp If no
594 c4cdcb68 2019-04-03 stsp .Ar path
595 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
596 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
597 f2ea84fa 2019-07-27 stsp specified paths.
598 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
599 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
600 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
601 f2cf8fbb 2019-04-04 stsp Some
602 f2cf8fbb 2019-04-04 stsp .Nm
603 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
604 c4cdcb68 2019-04-03 stsp multiple base commits.
605 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
606 47ec7be7 2019-05-12 stsp .Cm got update
607 47ec7be7 2019-05-12 stsp across the entire work tree.
608 024e9686 2019-05-14 stsp Specifying a
609 024e9686 2019-05-14 stsp .Ar path
610 024e9686 2019-05-14 stsp is incompatible with the
611 024e9686 2019-05-14 stsp .Fl b
612 024e9686 2019-05-14 stsp option.
613 7f838b36 2019-02-08 stsp .Pp
614 4ed9f614 2019-08-04 stsp .Cm got update
615 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
616 4ed9f614 2019-08-04 stsp If changes have been staged with
617 4ed9f614 2019-08-04 stsp .Cm got stage ,
618 bc3056e3 2019-08-18 stsp these changes must first be committed with
619 4ed9f614 2019-08-04 stsp .Cm got commit
620 4ed9f614 2019-08-04 stsp or unstaged with
621 4ed9f614 2019-08-04 stsp .Cm got unstage .
622 4ed9f614 2019-08-04 stsp .Pp
623 507dc3bb 2018-12-29 stsp The options for
624 507dc3bb 2018-12-29 stsp .Cm got update
625 507dc3bb 2018-12-29 stsp are as follows:
626 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
627 024e9686 2019-05-14 stsp .It Fl b Ar branch
628 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
629 024e9686 2019-05-14 stsp .Ar branch
630 024e9686 2019-05-14 stsp before updating the work tree.
631 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
632 4f331d3a 2020-04-01 stsp .Pp
633 4f331d3a 2020-04-01 stsp As usual, any local changes in the work tree will be preserved.
634 4f331d3a 2020-04-01 stsp This can be useful when switching to a newly created branch in order
635 4f331d3a 2020-04-01 stsp to commit existing local changes to this branch.
636 4f331d3a 2020-04-01 stsp .Pp
637 4f331d3a 2020-04-01 stsp Any local changes must be dealt with separately in order to obtain a
638 4f331d3a 2020-04-01 stsp work tree with pristine file contents corresponding exactly to the specified
639 4f331d3a 2020-04-01 stsp .Ar branch .
640 4f331d3a 2020-04-01 stsp Such changes could first be committed to a different branch with
641 4f331d3a 2020-04-01 stsp .Cm got commit ,
642 4f331d3a 2020-04-01 stsp or could be discarded with
643 4f331d3a 2020-04-01 stsp .Cm got revert .
644 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
645 507dc3bb 2018-12-29 stsp Update the work tree to the specified
646 507dc3bb 2018-12-29 stsp .Ar commit .
647 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
648 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
649 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
650 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
651 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
652 024e9686 2019-05-14 stsp branch will be used.
653 507dc3bb 2018-12-29 stsp .El
654 97b3a7be 2019-07-09 stsp .It Cm up
655 97b3a7be 2019-07-09 stsp Short alias for
656 97b3a7be 2019-07-09 stsp .Cm update .
657 3217be6d 2021-06-22 stsp .It Cm status Oo Fl I Oc Oo Fl s Ar status-codes Oc Op Ar path ...
658 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
659 6bad629b 2019-02-04 stsp using the following status codes:
660 6bad629b 2019-02-04 stsp .Bl -column YXZ description
661 6bad629b 2019-02-04 stsp .It M Ta modified file
662 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
663 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
664 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
665 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
666 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
667 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
668 6bad629b 2019-02-04 stsp .Nm
669 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
670 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
671 2a06fe5f 2019-08-24 stsp .Ar path
672 2a06fe5f 2019-08-24 stsp specified on the command line
673 6bad629b 2019-02-04 stsp .El
674 6bad629b 2019-02-04 stsp .Pp
675 72ea6654 2019-07-27 stsp If no
676 927df6b7 2019-02-10 stsp .Ar path
677 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
678 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
679 4ed9f614 2019-08-04 stsp .Pp
680 4ed9f614 2019-08-04 stsp If changes have been staged with
681 4ed9f614 2019-08-04 stsp .Cm got stage ,
682 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
683 4ed9f614 2019-08-04 stsp status codes:
684 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
685 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
686 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
687 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
688 4ed9f614 2019-08-04 stsp .El
689 4ed9f614 2019-08-04 stsp .Pp
690 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
691 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
692 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
693 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
694 4ed9f614 2019-08-04 stsp .El
695 6841da00 2019-08-08 stsp .Pp
696 081470ac 2020-08-13 stsp The options for
697 081470ac 2020-08-13 stsp .Cm got status
698 081470ac 2020-08-13 stsp are as follows:
699 081470ac 2020-08-13 stsp .Bl -tag -width Ds
700 f6343036 2021-06-22 stsp .It Fl I
701 f6343036 2021-06-22 stsp Show unversioned files even if they match an ignore pattern.
702 081470ac 2020-08-13 stsp .It Fl s Ar status-codes
703 081470ac 2020-08-13 stsp Only show files with a modification status matching any of the
704 081470ac 2020-08-13 stsp single-character status codes contained in the
705 081470ac 2020-08-13 stsp .Ar status-codes
706 081470ac 2020-08-13 stsp argument.
707 081470ac 2020-08-13 stsp Any combination of codes from the above list of possible status codes
708 081470ac 2020-08-13 stsp may be specified.
709 081470ac 2020-08-13 stsp For staged files, status codes displayed in either column will be matched.
710 081470ac 2020-08-13 stsp .El
711 081470ac 2020-08-13 stsp .Pp
712 6841da00 2019-08-08 stsp For compatibility with
713 bd8de430 2019-10-04 stsp .Xr cvs 1
714 bd8de430 2019-10-04 stsp and
715 bd8de430 2019-10-04 stsp .Xr git 1 ,
716 6841da00 2019-08-08 stsp .Cm got status
717 bd8de430 2019-10-04 stsp reads
718 bd8de430 2019-10-04 stsp .Xr glob 7
719 bd8de430 2019-10-04 stsp patterns from
720 6841da00 2019-08-08 stsp .Pa .cvsignore
721 bd8de430 2019-10-04 stsp and
722 bd8de430 2019-10-04 stsp .Pa .gitignore
723 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
724 bd8de430 2019-10-04 stsp which match these patterns.
725 bd8de430 2019-10-04 stsp As an extension to
726 6841da00 2019-08-08 stsp .Xr glob 7
727 bd8de430 2019-10-04 stsp matching rules,
728 bd8de430 2019-10-04 stsp .Cm got status
729 bd8de430 2019-10-04 stsp supports consecutive asterisks,
730 bd8de430 2019-10-04 stsp .Dq ** ,
731 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
732 6841da00 2019-08-08 stsp Unlike
733 6841da00 2019-08-08 stsp .Xr cvs 1 ,
734 6841da00 2019-08-08 stsp .Cm got status
735 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
736 bd8de430 2019-10-04 stsp Unlike
737 bd8de430 2019-10-04 stsp .Xr git 1 ,
738 bd8de430 2019-10-04 stsp .Cm got status
739 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
740 bd8de430 2019-10-04 stsp .Dq \&! ,
741 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
742 bd8de430 2019-10-04 stsp .Dq / ,
743 bd8de430 2019-10-04 stsp in a pattern.
744 97b3a7be 2019-07-09 stsp .It Cm st
745 97b3a7be 2019-07-09 stsp Short alias for
746 97b3a7be 2019-07-09 stsp .Cm status .
747 0208f208 2020-05-05 stsp .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl P Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Oo Fl R Oc Oo Fl x Ar commit Oc Op Ar path
748 38e11793 2018-06-13 stsp Display history of a repository.
749 04ca23f4 2018-07-16 stsp If a
750 04ca23f4 2018-07-16 stsp .Ar path
751 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
752 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
753 dc990cbf 2020-02-22 stsp .Ar path
754 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
755 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
756 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
757 38e11793 2018-06-13 stsp .Pp
758 38e11793 2018-06-13 stsp The options for
759 38e11793 2018-06-13 stsp .Cm got log
760 38e11793 2018-06-13 stsp are as follows:
761 38e11793 2018-06-13 stsp .Bl -tag -width Ds
762 48c8c60d 2020-01-27 stsp .It Fl b
763 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
764 1137e0ae 2020-01-27 stsp from other branches.
765 48c8c60d 2020-01-27 stsp By default,
766 48c8c60d 2020-01-27 stsp .Cm got log
767 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
768 38e11793 2018-06-13 stsp .It Fl c Ar commit
769 38e11793 2018-06-13 stsp Start traversing history at the specified
770 38e11793 2018-06-13 stsp .Ar commit .
771 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
772 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
773 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
774 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
775 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
776 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
777 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
778 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
779 c0cc5c62 2018-10-18 stsp .Fl p .
780 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
781 6238ee32 2018-06-13 stsp .It Fl l Ar N
782 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
783 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
784 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
785 b1ebc001 2019-08-13 stsp The
786 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
787 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
788 6238ee32 2018-06-13 stsp .It Fl p
789 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
790 44392932 2019-08-25 stsp If a
791 44392932 2019-08-25 stsp .Ar path
792 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
793 0208f208 2020-05-05 stsp .It Fl P
794 0208f208 2020-05-05 stsp Display the list of file paths changed in each commit, using the following
795 0208f208 2020-05-05 stsp status codes:
796 0208f208 2020-05-05 stsp .Bl -column YXZ description
797 0208f208 2020-05-05 stsp .It M Ta modified file
798 0208f208 2020-05-05 stsp .It D Ta file was deleted
799 0208f208 2020-05-05 stsp .It A Ta new file was added
800 0208f208 2020-05-05 stsp .It m Ta modified file modes (executable bit only)
801 0208f208 2020-05-05 stsp .El
802 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
803 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
804 6841bf13 2019-11-29 kn regular expression
805 6841bf13 2019-11-29 kn .Ar search-pattern .
806 0208f208 2020-05-05 stsp When used together with
807 0208f208 2020-05-05 stsp .Fl P
808 0208f208 2020-05-05 stsp then the file paths changed by a commit can be matched as well.
809 6841bf13 2019-11-29 kn Regular expression syntax is documented in
810 6841bf13 2019-11-29 kn .Xr re_format 7 .
811 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
812 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
813 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
814 04ca23f4 2018-07-16 stsp working directory.
815 e9cf2e30 2019-02-05 stsp If this directory is a
816 e9cf2e30 2019-02-05 stsp .Nm
817 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
818 dbec59df 2020-04-18 stsp .It Fl R
819 dbec59df 2020-04-18 stsp Determine a set of commits to display as usual, but display these commits
820 dbec59df 2020-04-18 stsp in reverse order.
821 d1fe46f9 2020-04-18 stsp .It Fl x Ar commit
822 4e20a648 2021-03-21 jrick Stop traversing commit history immediately after the specified
823 d1fe46f9 2020-04-18 stsp .Ar commit
824 52ab7958 2020-04-18 stsp has been traversed.
825 d1fe46f9 2020-04-18 stsp This option has no effect if the specified
826 d1fe46f9 2020-04-18 stsp .Ar commit
827 d1fe46f9 2020-04-18 stsp is never traversed.
828 38e11793 2018-06-13 stsp .El
829 64453f7e 2020-11-21 stsp .It Cm diff Oo Fl a Oc Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path
830 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
831 bd81cfb7 2020-04-19 stsp local changes in the work tree.
832 927df6b7 2019-02-10 stsp If a
833 927df6b7 2019-02-10 stsp .Ar path
834 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
835 927df6b7 2019-02-10 stsp .Pp
836 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
837 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
838 d24820bf 2019-08-11 stsp corresponding objects.
839 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
840 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
841 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
842 c0cc5c62 2018-10-18 stsp .Pp
843 c0cc5c62 2018-10-18 stsp The options for
844 c0cc5c62 2018-10-18 stsp .Cm got diff
845 c0cc5c62 2018-10-18 stsp are as follows:
846 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
847 64453f7e 2020-11-21 stsp .It Fl a
848 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
849 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
850 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
851 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
852 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
853 b72f483a 2019-02-05 stsp Use the repository at the specified path.
854 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
855 b72f483a 2019-02-05 stsp working directory.
856 b72f483a 2019-02-05 stsp If this directory is a
857 b72f483a 2019-02-05 stsp .Nm
858 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
859 4ed9f614 2019-08-04 stsp .It Fl s
860 4ed9f614 2019-08-04 stsp Show changes staged with
861 4ed9f614 2019-08-04 stsp .Cm got stage
862 bd81cfb7 2020-04-19 stsp instead of showing local changes in the work tree.
863 4ed9f614 2019-08-04 stsp This option is only valid when
864 4ed9f614 2019-08-04 stsp .Cm got diff
865 4ed9f614 2019-08-04 stsp is invoked in a work tree.
866 63035f9f 2019-10-06 stsp .It Fl w
867 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
868 c0cc5c62 2018-10-18 stsp .El
869 bc26cce8 2019-08-04 stsp .It Cm di
870 bc26cce8 2019-08-04 stsp Short alias for
871 bc26cce8 2019-08-04 stsp .Cm diff .
872 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
873 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
874 1ff8e573 2018-08-02 stsp .Pp
875 1ff8e573 2018-08-02 stsp The options for
876 1ff8e573 2018-08-02 stsp .Cm got blame
877 1ff8e573 2018-08-02 stsp are as follows:
878 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
879 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
880 1ff8e573 2018-08-02 stsp Start traversing history at the specified
881 1ff8e573 2018-08-02 stsp .Ar commit .
882 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
883 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
884 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
885 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
886 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
887 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
888 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
889 1ff8e573 2018-08-02 stsp working directory.
890 0c06baac 2019-02-05 stsp If this directory is a
891 0c06baac 2019-02-05 stsp .Nm
892 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
893 5c860e29 2018-03-12 stsp .El
894 bc26cce8 2019-08-04 stsp .It Cm bl
895 bc26cce8 2019-08-04 stsp Short alias for
896 bc26cce8 2019-08-04 stsp .Cm blame .
897 dfc23429 2019-08-11 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl i Oc Oo Fl R Oc Op Ar path
898 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
899 5de5890b 2018-10-18 stsp directory path in the repository.
900 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
901 db0c2996 2019-02-10 stsp annotations:
902 db0c2996 2019-02-10 stsp .Bl -column YXZ description
903 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
904 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
905 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
906 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
907 db0c2996 2019-02-10 stsp .El
908 0d6c6ee3 2020-05-20 stsp .Pp
909 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
910 db0c2996 2019-02-10 stsp .Pp
911 0c849583 2019-02-05 stsp If no
912 0c849583 2019-02-05 stsp .Ar path
913 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
914 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
915 0c849583 2019-02-05 stsp if there is no work tree.
916 5de5890b 2018-10-18 stsp .Pp
917 5de5890b 2018-10-18 stsp The options for
918 5de5890b 2018-10-18 stsp .Cm got tree
919 5de5890b 2018-10-18 stsp are as follows:
920 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
921 5de5890b 2018-10-18 stsp .It Fl c Ar commit
922 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
923 5de5890b 2018-10-18 stsp .Ar commit .
924 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
925 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
926 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
927 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
928 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
929 5de5890b 2018-10-18 stsp Use the repository at the specified path.
930 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
931 5de5890b 2018-10-18 stsp working directory.
932 0c849583 2019-02-05 stsp If this directory is a
933 0c849583 2019-02-05 stsp .Nm
934 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
935 5de5890b 2018-10-18 stsp .It Fl i
936 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
937 c1669e2e 2019-01-09 stsp .It Fl R
938 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
939 d0eebce4 2019-03-11 stsp .El
940 bc26cce8 2019-08-04 stsp .It Cm tr
941 bc26cce8 2019-08-04 stsp Short alias for
942 bc26cce8 2019-08-04 stsp .Cm tree .
943 e31abbf2 2020-03-22 stsp .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl c Ar object Oc Oo Fl s Ar reference Oc Oo Fl d Oc Op Ar name
944 d0eebce4 2019-03-11 stsp Manage references in a repository.
945 d0eebce4 2019-03-11 stsp .Pp
946 e31abbf2 2020-03-22 stsp References may be listed, created, deleted, and changed.
947 e31abbf2 2020-03-22 stsp When creating, deleting, or changing a reference the specified
948 e31abbf2 2020-03-22 stsp .Ar name
949 e31abbf2 2020-03-22 stsp must be an absolute reference name, i.e. it must begin with
950 f16e4044 2019-10-09 stsp .Dq refs/ .
951 e31abbf2 2020-03-22 stsp .Pp
952 d0eebce4 2019-03-11 stsp The options for
953 d0eebce4 2019-03-11 stsp .Cm got ref
954 d0eebce4 2019-03-11 stsp are as follows:
955 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
956 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
957 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
958 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
959 d0eebce4 2019-03-11 stsp working directory.
960 d0eebce4 2019-03-11 stsp If this directory is a
961 d0eebce4 2019-03-11 stsp .Nm
962 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
963 d0eebce4 2019-03-11 stsp .It Fl l
964 b2070a3f 2020-03-22 stsp List references in the repository.
965 b2070a3f 2020-03-22 stsp If no
966 b2070a3f 2020-03-22 stsp .Ar name
967 b2070a3f 2020-03-22 stsp is specified, list all existing references in the repository.
968 b2070a3f 2020-03-22 stsp If
969 b2070a3f 2020-03-22 stsp .Ar name
970 b2070a3f 2020-03-22 stsp is a reference namespace, list all references in this namespace.
971 b2070a3f 2020-03-22 stsp Otherwise, show only the reference with the given
972 b2070a3f 2020-03-22 stsp .Ar name .
973 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
974 e31abbf2 2020-03-22 stsp .Fl r .
975 e31abbf2 2020-03-22 stsp .It Fl c Ar object
976 e31abbf2 2020-03-22 stsp Create a reference or change an existing reference.
977 e31abbf2 2020-03-22 stsp The reference with the specified
978 e31abbf2 2020-03-22 stsp .Ar name
979 e31abbf2 2020-03-22 stsp will point at the specified
980 1795b260 2021-04-02 kn .Ar object .
981 e31abbf2 2020-03-22 stsp The expected
982 e31abbf2 2020-03-22 stsp .Ar object
983 e31abbf2 2020-03-22 stsp argument is a ID SHA1 hash or an existing reference or tag name which will
984 e31abbf2 2020-03-22 stsp be resolved to the ID of a corresponding commit, tree, tag, or blob object.
985 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
986 e31abbf2 2020-03-22 stsp .Fl r .
987 e31abbf2 2020-03-22 stsp .It Fl s Ar reference
988 e31abbf2 2020-03-22 stsp Create a symbolic reference, or change an existing symbolic reference.
989 e31abbf2 2020-03-22 stsp The symbolic reference with the specified
990 e31abbf2 2020-03-22 stsp .Ar name
991 e31abbf2 2020-03-22 stsp will point at the specified
992 e31abbf2 2020-03-22 stsp .Ar reference
993 e31abbf2 2020-03-22 stsp which must already exist in the repository.
994 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
995 d1c1ae5f 2019-08-12 stsp this option is used.
996 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
997 e31abbf2 2020-03-22 stsp .Fl r .
998 e31abbf2 2020-03-22 stsp .It Fl d
999 e31abbf2 2020-03-22 stsp Delete the reference with the specified
1000 e31abbf2 2020-03-22 stsp .Ar name
1001 e31abbf2 2020-03-22 stsp from the repository.
1002 601aba22 2021-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted references
1003 601aba22 2021-03-21 stsp remain in the repository and may be removed separately with
1004 e6786710 2021-07-03 stsp Git's garbage collector or
1005 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1006 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1007 e31abbf2 2020-03-22 stsp .Fl r .
1008 4e759de4 2019-06-26 stsp .El
1009 da76fce2 2020-02-24 stsp .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl n Oc Op Ar name
1010 da76fce2 2020-02-24 stsp Create, list, or delete branches.
1011 4e759de4 2019-06-26 stsp .Pp
1012 34d4e04c 2021-02-08 stsp Local branches are managed via references which live in the
1013 4e759de4 2019-06-26 stsp .Dq refs/heads/
1014 4e759de4 2019-06-26 stsp reference namespace.
1015 4e759de4 2019-06-26 stsp The
1016 4e759de4 2019-06-26 stsp .Cm got branch
1017 34d4e04c 2021-02-08 stsp command creates or deletes references in this namespace only.
1018 4e759de4 2019-06-26 stsp .Pp
1019 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1020 ad89fa31 2019-10-04 stsp work tree's current branch.
1021 da76fce2 2020-02-24 stsp .Pp
1022 a74f7e83 2019-11-10 stsp If a
1023 a74f7e83 2019-11-10 stsp .Ar name
1024 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1025 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1026 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1027 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1028 4e759de4 2019-06-26 stsp .Pp
1029 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1030 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1031 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1032 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1033 da76fce2 2020-02-24 stsp would do.
1034 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1035 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1036 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1037 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1038 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1039 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1040 da76fce2 2020-02-24 stsp .It A Ta new file was added
1041 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1042 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1043 da76fce2 2020-02-24 stsp .El
1044 da76fce2 2020-02-24 stsp .Pp
1045 4e759de4 2019-06-26 stsp The options for
1046 4e759de4 2019-06-26 stsp .Cm got branch
1047 4e759de4 2019-06-26 stsp are as follows:
1048 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
1049 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1050 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1051 a74f7e83 2019-11-10 stsp .Ar commit .
1052 a74f7e83 2019-11-10 stsp The expected
1053 a74f7e83 2019-11-10 stsp .Ar commit
1054 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
1055 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
1056 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
1057 4e759de4 2019-06-26 stsp Use the repository at the specified path.
1058 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
1059 4e759de4 2019-06-26 stsp working directory.
1060 4e759de4 2019-06-26 stsp If this directory is a
1061 4e759de4 2019-06-26 stsp .Nm
1062 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
1063 4e759de4 2019-06-26 stsp .It Fl l
1064 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1065 34d4e04c 2021-02-08 stsp repositories' branches in the
1066 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1067 34d4e04c 2021-02-08 stsp reference namespace.
1068 34d4e04c 2021-02-08 stsp .Pp
1069 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1070 ba882ee3 2019-07-11 stsp with one the following annotations:
1071 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1072 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
1073 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
1074 ba882ee3 2019-07-11 stsp .El
1075 4e759de4 2019-06-26 stsp .It Fl d Ar name
1076 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
1077 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
1078 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
1079 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
1080 e6786710 2021-07-03 stsp Git's garbage collector or
1081 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1082 da76fce2 2020-02-24 stsp .It Fl n
1083 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
1084 5de5890b 2018-10-18 stsp .El
1085 97b3a7be 2019-07-09 stsp .It Cm br
1086 97b3a7be 2019-07-09 stsp Short alias for
1087 97b3a7be 2019-07-09 stsp .Cm branch .
1088 80106605 2020-02-24 stsp .It Cm tag Oo Fl c Ar commit Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name
1089 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1090 8e7bd50a 2019-08-22 stsp .Pp
1091 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1092 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1093 8e7bd50a 2019-08-22 stsp reference namespace.
1094 8e7bd50a 2019-08-22 stsp The
1095 8e7bd50a 2019-08-22 stsp .Cm got tag
1096 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1097 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1098 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1099 8e7bd50a 2019-08-22 stsp .Pp
1100 80106605 2020-02-24 stsp Attempt to create a tag with the given
1101 8e7bd50a 2019-08-22 stsp .Ar name ,
1102 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1103 8e7bd50a 2019-08-22 stsp .Ar commit .
1104 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1105 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1106 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1107 8e7bd50a 2019-08-22 stsp .Pp
1108 8e7bd50a 2019-08-22 stsp The options for
1109 8e7bd50a 2019-08-22 stsp .Cm got tag
1110 8e7bd50a 2019-08-22 stsp are as follows:
1111 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1112 80106605 2020-02-24 stsp .It Fl c Ar commit
1113 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1114 80106605 2020-02-24 stsp .Ar commit .
1115 80106605 2020-02-24 stsp The expected
1116 80106605 2020-02-24 stsp .Ar commit
1117 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
1118 80106605 2020-02-24 stsp will be resolved to a commit ID.
1119 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1120 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1121 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
1122 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
1123 8e7bd50a 2019-08-22 stsp Without the
1124 8e7bd50a 2019-08-22 stsp .Fl m
1125 8e7bd50a 2019-08-22 stsp option,
1126 3a62228f 2019-11-08 stsp .Cm got tag
1127 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
1128 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
1129 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
1130 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1131 8e7bd50a 2019-08-22 stsp working directory.
1132 8e7bd50a 2019-08-22 stsp If this directory is a
1133 8e7bd50a 2019-08-22 stsp .Nm
1134 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1135 8e7bd50a 2019-08-22 stsp .It Fl l
1136 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
1137 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
1138 8e7bd50a 2019-08-22 stsp .El
1139 8e7bd50a 2019-08-22 stsp .Pp
1140 8e7bd50a 2019-08-22 stsp By design, the
1141 8e7bd50a 2019-08-22 stsp .Cm got tag
1142 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1143 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1144 8e7bd50a 2019-08-22 stsp .Cm got ref
1145 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1146 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1147 8e7bd50a 2019-08-22 stsp another repository.
1148 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1149 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1150 d00136be 2019-03-26 stsp repository in the next commit.
1151 ff56836b 2021-07-08 stsp By default, files which match a
1152 ff56836b 2021-07-08 stsp .Cm got status
1153 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1154 4e68cba3 2019-11-23 stsp .Pp
1155 4e68cba3 2019-11-23 stsp The options for
1156 4e68cba3 2019-11-23 stsp .Cm got add
1157 4e68cba3 2019-11-23 stsp are as follows:
1158 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1159 4e68cba3 2019-11-23 stsp .It Fl R
1160 4e68cba3 2019-11-23 stsp Permit recursion into directories.
1161 4e68cba3 2019-11-23 stsp If this option is not specified,
1162 4e68cba3 2019-11-23 stsp .Cm got add
1163 4e68cba3 2019-11-23 stsp will refuse to run if a specified
1164 4e68cba3 2019-11-23 stsp .Ar path
1165 4e68cba3 2019-11-23 stsp is a directory.
1166 022fae89 2019-12-06 tracey .It Fl I
1167 ff56836b 2021-07-08 stsp Add files even if they match a
1168 022fae89 2019-12-06 tracey .Cm got status
1169 022fae89 2019-12-06 tracey ignore pattern.
1170 4e68cba3 2019-11-23 stsp .El
1171 766841c2 2020-08-13 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1172 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1173 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1174 2ec1f75b 2019-03-26 stsp .Pp
1175 2ec1f75b 2019-03-26 stsp The options for
1176 86d25a1b 2019-07-11 stsp .Cm got remove
1177 2ec1f75b 2019-03-26 stsp are as follows:
1178 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1179 2ec1f75b 2019-03-26 stsp .It Fl f
1180 bd81cfb7 2020-04-19 stsp Perform the operation even if a file contains local modifications.
1181 70e3e7f5 2019-12-13 tracey .It Fl k
1182 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1183 f2a9dc41 2019-12-13 tracey .It Fl R
1184 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1185 f2a9dc41 2019-12-13 tracey If this option is not specified,
1186 f2a9dc41 2019-12-13 tracey .Cm got remove
1187 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1188 f2a9dc41 2019-12-13 tracey .Ar path
1189 f2a9dc41 2019-12-13 tracey is a directory.
1190 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1191 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1192 766841c2 2020-08-13 stsp single-character status codes contained in the
1193 766841c2 2020-08-13 stsp .Ar status-codes
1194 766841c2 2020-08-13 stsp argument.
1195 766841c2 2020-08-13 stsp The following status codes may be specified:
1196 766841c2 2020-08-13 stsp .Bl -column YXZ description
1197 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1198 766841c2 2020-08-13 stsp .Fl f
1199 766841c2 2020-08-13 stsp option)
1200 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1201 766841c2 2020-08-13 stsp .El
1202 d0eebce4 2019-03-11 stsp .El
1203 648e4ef7 2019-07-09 stsp .It Cm rm
1204 648e4ef7 2019-07-09 stsp Short alias for
1205 648e4ef7 2019-07-09 stsp .Cm remove .
1206 dfc23429 2019-08-11 stsp .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1207 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
1208 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
1209 1dd86744 2019-08-12 anthony work tree's base commit.
1210 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
1211 a129376b 2019-03-28 stsp .Cm got revert !
1212 a129376b 2019-03-28 stsp .Pp
1213 e20a8b6f 2019-06-04 stsp If a file was added with
1214 a129376b 2019-03-28 stsp .Cm got add
1215 a129376b 2019-03-28 stsp it will become an unversioned file again.
1216 e20a8b6f 2019-06-04 stsp If a file was deleted with
1217 86d25a1b 2019-07-11 stsp .Cm got remove
1218 a129376b 2019-03-28 stsp it will be restored.
1219 0f6d7415 2019-08-08 stsp .Pp
1220 0f6d7415 2019-08-08 stsp The options for
1221 0f6d7415 2019-08-08 stsp .Cm got revert
1222 0f6d7415 2019-08-08 stsp are as follows:
1223 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
1224 33aa809d 2019-08-08 stsp .It Fl p
1225 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
1226 33aa809d 2019-08-08 stsp changes to revert based on
1227 33aa809d 2019-08-08 stsp .Dq y
1228 33aa809d 2019-08-08 stsp (revert change),
1229 33aa809d 2019-08-08 stsp .Dq n
1230 33aa809d 2019-08-08 stsp (keep change), and
1231 33aa809d 2019-08-08 stsp .Dq q
1232 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
1233 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
1234 33aa809d 2019-08-08 stsp modified file content can be reverted.
1235 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
1236 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
1237 33aa809d 2019-08-08 stsp With the
1238 33aa809d 2019-08-08 stsp .Fl p
1239 33aa809d 2019-08-08 stsp option, read
1240 33aa809d 2019-08-08 stsp .Dq y ,
1241 33aa809d 2019-08-08 stsp .Dq n ,
1242 33aa809d 2019-08-08 stsp and
1243 33aa809d 2019-08-08 stsp .Dq q
1244 33aa809d 2019-08-08 stsp responses line-by-line from the specified
1245 33aa809d 2019-08-08 stsp .Ar response-script
1246 33aa809d 2019-08-08 stsp file instead of prompting interactively.
1247 0f6d7415 2019-08-08 stsp .It Fl R
1248 0f6d7415 2019-08-08 stsp Permit recursion into directories.
1249 0f6d7415 2019-08-08 stsp If this option is not specified,
1250 0f6d7415 2019-08-08 stsp .Cm got revert
1251 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1252 0f6d7415 2019-08-08 stsp .Ar path
1253 0f6d7415 2019-08-08 stsp is a directory.
1254 0f6d7415 2019-08-08 stsp .El
1255 97b3a7be 2019-07-09 stsp .It Cm rv
1256 97b3a7be 2019-07-09 stsp Short alias for
1257 97b3a7be 2019-07-09 stsp .Cm revert .
1258 28cf319f 2021-01-28 stsp .It Cm commit Oo Fl F Ar path Oc Oo Fl m Ar message Oc Oo Fl N Oc Oo Fl S Oc Op Ar path ...
1259 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1260 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1261 5c1e53bc 2019-07-28 stsp If no
1262 90e8619e 2019-07-25 stsp .Ar path
1263 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1264 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1265 15cd91f7 2019-05-12 stsp .Pp
1266 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1267 1dd86744 2019-08-12 anthony .Cm got stage ,
1268 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1269 4ed9f614 2019-08-04 stsp have not been staged.
1270 4ed9f614 2019-08-04 stsp .Pp
1271 28cf319f 2021-01-28 stsp .Cm got commit
1272 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
1273 28cf319f 2021-01-28 stsp unless the
1274 28cf319f 2021-01-28 stsp .Fl m
1275 28cf319f 2021-01-28 stsp option is used
1276 28cf319f 2021-01-28 stsp or the
1277 28cf319f 2021-01-28 stsp .Fl F
1278 28cf319f 2021-01-28 stsp and
1279 28cf319f 2021-01-28 stsp .Fl N
1280 28cf319f 2021-01-28 stsp options are used together.
1281 28cf319f 2021-01-28 stsp .Pp
1282 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1283 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1284 15cd91f7 2019-05-12 stsp .It M Ta modified file
1285 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1286 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1287 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1288 15cd91f7 2019-05-12 stsp .El
1289 15cd91f7 2019-05-12 stsp .Pp
1290 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1291 996d5ccd 2019-08-05 stsp recorded base commit.
1292 15cd91f7 2019-05-12 stsp Some
1293 15cd91f7 2019-05-12 stsp .Nm
1294 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1295 15cd91f7 2019-05-12 stsp multiple base commits.
1296 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1297 47ec7be7 2019-05-12 stsp .Cm got update
1298 47ec7be7 2019-05-12 stsp across the entire work tree.
1299 15cd91f7 2019-05-12 stsp .Pp
1300 15cd91f7 2019-05-12 stsp The
1301 15cd91f7 2019-05-12 stsp .Cm got commit
1302 15cd91f7 2019-05-12 stsp command requires the
1303 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1304 aba9c984 2019-09-08 stsp environment variable to be set,
1305 257add31 2020-09-09 stsp unless an author has been configured in
1306 257add31 2020-09-09 stsp .Xr got.conf 5
1307 257add31 2020-09-09 stsp or Git's
1308 aba9c984 2019-09-08 stsp .Dv user.name
1309 aba9c984 2019-09-08 stsp and
1310 709ae9eb 2019-09-08 stsp .Dv user.email
1311 709ae9eb 2019-09-08 stsp configuration settings can be
1312 aba9c984 2019-09-08 stsp obtained from the repository's
1313 aba9c984 2019-09-08 stsp .Pa .git/config
1314 c9956ddf 2019-09-08 stsp file or from Git's global
1315 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1316 c9956ddf 2019-09-08 stsp configuration file.
1317 74416c47 2019-05-09 stsp .Pp
1318 74416c47 2019-05-09 stsp The options for
1319 74416c47 2019-05-09 stsp .Cm got commit
1320 74416c47 2019-05-09 stsp are as follows:
1321 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1322 28cf319f 2021-01-28 stsp .It Fl F Ar path
1323 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
1324 28cf319f 2021-01-28 stsp .Ar path
1325 28cf319f 2021-01-28 stsp when creating the new commit.
1326 28cf319f 2021-01-28 stsp .Cm got commit
1327 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
1328 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
1329 28cf319f 2021-01-28 stsp Cannot be used together with the
1330 23594da9 2019-05-13 stsp .Fl m
1331 28cf319f 2021-01-28 stsp option.
1332 28cf319f 2021-01-28 stsp .It Fl m Ar message
1333 28cf319f 2021-01-28 stsp Use the specified log message when creating the new commit.
1334 28cf319f 2021-01-28 stsp Cannot be used together with the
1335 28cf319f 2021-01-28 stsp .Fl F
1336 28cf319f 2021-01-28 stsp option.
1337 28cf319f 2021-01-28 stsp .It Fl N
1338 28cf319f 2021-01-28 stsp This option prevents
1339 23594da9 2019-05-13 stsp .Cm got commit
1340 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
1341 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
1342 28cf319f 2021-01-28 stsp .Fl F
1343 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
1344 35213c7c 2020-07-23 stsp .It Fl S
1345 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
1346 af358f55 2020-07-23 stsp that is under version control.
1347 af358f55 2020-07-23 stsp By default,
1348 af358f55 2020-07-23 stsp .Cm got commit
1349 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
1350 35213c7c 2020-07-23 stsp As a precaution,
1351 35213c7c 2020-07-23 stsp .Nm
1352 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
1353 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
1354 af358f55 2020-07-23 stsp points outside of the work tree.
1355 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
1356 af358f55 2020-07-23 stsp .Dq make obj
1357 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
1358 af358f55 2020-07-23 stsp version control.
1359 2ec1f75b 2019-03-26 stsp .El
1360 cfce0458 2019-07-28 stsp .Pp
1361 cfce0458 2019-07-28 stsp .Cm got commit
1362 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1363 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1364 916f288c 2019-07-30 stsp .Dq refs/heads/
1365 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1366 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1367 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1368 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1369 cfce0458 2019-07-28 stsp .Cm got update
1370 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1371 cfce0458 2019-07-28 stsp in the repository.
1372 97b3a7be 2019-07-09 stsp .It Cm ci
1373 97b3a7be 2019-07-09 stsp Short alias for
1374 97b3a7be 2019-07-09 stsp .Cm commit .
1375 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1376 234035bc 2019-06-01 stsp Merge changes from a single
1377 234035bc 2019-06-01 stsp .Ar commit
1378 234035bc 2019-06-01 stsp into the work tree.
1379 234035bc 2019-06-01 stsp The specified
1380 234035bc 2019-06-01 stsp .Ar commit
1381 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
1382 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1383 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1384 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1385 234035bc 2019-06-01 stsp .Pp
1386 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1387 234035bc 2019-06-01 stsp .Bl -column YXZ description
1388 234035bc 2019-06-01 stsp .It G Ta file was merged
1389 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1390 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1391 234035bc 2019-06-01 stsp .It D Ta file was deleted
1392 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1393 234035bc 2019-06-01 stsp .It A Ta new file was added
1394 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1395 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1396 74416c47 2019-05-09 stsp .El
1397 234035bc 2019-06-01 stsp .Pp
1398 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1399 234035bc 2019-06-01 stsp may be viewed with
1400 234035bc 2019-06-01 stsp .Cm got diff ,
1401 234035bc 2019-06-01 stsp amended manually or with further
1402 234035bc 2019-06-01 stsp .Cm got cherrypick
1403 bc3056e3 2019-08-18 stsp commands,
1404 234035bc 2019-06-01 stsp committed with
1405 234035bc 2019-06-01 stsp .Cm got commit ,
1406 234035bc 2019-06-01 stsp or discarded again with
1407 234035bc 2019-06-01 stsp .Cm got revert .
1408 234035bc 2019-06-01 stsp .Pp
1409 234035bc 2019-06-01 stsp .Cm got cherrypick
1410 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1411 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1412 234035bc 2019-06-01 stsp to a single base commit with
1413 234035bc 2019-06-01 stsp .Cm got update .
1414 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1415 234035bc 2019-06-01 stsp conflicts must be resolved first.
1416 016477fd 2019-07-09 stsp .It Cm cy
1417 97b3a7be 2019-07-09 stsp Short alias for
1418 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1419 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1420 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1421 5ef14e63 2019-06-02 stsp .Ar commit
1422 5ef14e63 2019-06-02 stsp into the work tree.
1423 5ef14e63 2019-06-02 stsp The specified
1424 5ef14e63 2019-06-02 stsp .Ar commit
1425 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
1426 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1427 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1428 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1429 5ef14e63 2019-06-02 stsp .Pp
1430 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1431 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1432 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1433 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1434 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1435 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1436 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1437 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1438 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1439 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1440 234035bc 2019-06-01 stsp .El
1441 5ef14e63 2019-06-02 stsp .Pp
1442 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1443 5ef14e63 2019-06-02 stsp which may be viewed with
1444 5ef14e63 2019-06-02 stsp .Cm got diff ,
1445 5ef14e63 2019-06-02 stsp amended manually or with further
1446 778a73c2 2019-07-12 stsp .Cm got backout
1447 bc3056e3 2019-08-18 stsp commands,
1448 5ef14e63 2019-06-02 stsp committed with
1449 5ef14e63 2019-06-02 stsp .Cm got commit ,
1450 5ef14e63 2019-06-02 stsp or discarded again with
1451 5ef14e63 2019-06-02 stsp .Cm got revert .
1452 5ef14e63 2019-06-02 stsp .Pp
1453 92228c38 2019-06-02 stsp .Cm got backout
1454 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1455 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1456 92228c38 2019-06-02 stsp to a single base commit with
1457 92228c38 2019-06-02 stsp .Cm got update .
1458 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1459 92228c38 2019-06-02 stsp conflicts must be resolved first.
1460 97b3a7be 2019-07-09 stsp .It Cm bo
1461 97b3a7be 2019-07-09 stsp Short alias for
1462 97b3a7be 2019-07-09 stsp .Cm backout .
1463 643b85bc 2021-07-16 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1464 818c7501 2019-07-11 stsp Rebase commits on the specified
1465 818c7501 2019-07-11 stsp .Ar branch
1466 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1467 818c7501 2019-07-11 stsp The
1468 818c7501 2019-07-11 stsp .Ar branch
1469 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1470 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1471 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1472 818c7501 2019-07-11 stsp .Ar branch
1473 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1474 f09e2405 2019-07-11 stsp of the specified
1475 818c7501 2019-07-11 stsp .Ar branch
1476 f09e2405 2019-07-11 stsp has been rebased.
1477 818c7501 2019-07-11 stsp .Pp
1478 2b6826ba 2020-02-24 stsp When
1479 2b6826ba 2020-02-24 stsp .Cm got rebase
1480 2b6826ba 2020-02-24 stsp is used as intended, the specified
1481 2b6826ba 2020-02-24 stsp .Ar branch
1482 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1483 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1484 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1485 2b6826ba 2020-02-24 stsp .Cm got update -b
1486 2b6826ba 2020-02-24 stsp before starting the
1487 2b6826ba 2020-02-24 stsp .Cm rebase
1488 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1489 2b6826ba 2020-02-24 stsp a common history with the specified
1490 2b6826ba 2020-02-24 stsp .Ar branch
1491 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1492 c10890ce 2020-02-25 stsp remote repository.
1493 2b6826ba 2020-02-24 stsp .Pp
1494 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1495 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1496 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1497 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1498 818c7501 2019-07-11 stsp .Ar branch ,
1499 818c7501 2019-07-11 stsp but with different commit IDs.
1500 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1501 f09e2405 2019-07-11 stsp the new version of the specified
1502 818c7501 2019-07-11 stsp .Ar branch
1503 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1504 e600f124 2021-03-21 stsp .Pp
1505 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
1506 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
1507 e600f124 2021-03-21 stsp reference namespace.
1508 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
1509 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
1510 e600f124 2021-03-21 stsp .Cm got rebase -l
1511 e600f124 2021-03-21 stsp command.
1512 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
1513 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
1514 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1515 818c7501 2019-07-11 stsp .Pp
1516 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1517 818c7501 2019-07-11 stsp using the following status codes:
1518 818c7501 2019-07-11 stsp .Bl -column YXZ description
1519 818c7501 2019-07-11 stsp .It G Ta file was merged
1520 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1521 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1522 818c7501 2019-07-11 stsp .It D Ta file was deleted
1523 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1524 818c7501 2019-07-11 stsp .It A Ta new file was added
1525 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1526 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1527 5ef14e63 2019-06-02 stsp .El
1528 818c7501 2019-07-11 stsp .Pp
1529 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1530 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1531 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1532 818c7501 2019-07-11 stsp .Ar branch
1533 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1534 818c7501 2019-07-11 stsp .Pp
1535 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1536 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1537 f09e2405 2019-07-11 stsp when the rebase operation continues.
1538 ff0d2220 2019-07-11 stsp .Pp
1539 818c7501 2019-07-11 stsp .Cm got rebase
1540 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1541 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1542 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1543 818c7501 2019-07-11 stsp .Cm got update .
1544 4ed9f614 2019-08-04 stsp If changes have been staged with
1545 4ed9f614 2019-08-04 stsp .Cm got stage ,
1546 bc3056e3 2019-08-18 stsp these changes must first be committed with
1547 4ed9f614 2019-08-04 stsp .Cm got commit
1548 4ed9f614 2019-08-04 stsp or unstaged with
1549 4ed9f614 2019-08-04 stsp .Cm got unstage .
1550 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1551 f09e2405 2019-07-11 stsp committed with
1552 f09e2405 2019-07-11 stsp .Cm got commit
1553 f09e2405 2019-07-11 stsp or reverted with
1554 f09e2405 2019-07-11 stsp .Cm got revert .
1555 64c6d990 2019-07-11 stsp If the
1556 64c6d990 2019-07-11 stsp .Ar branch
1557 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1558 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1559 818c7501 2019-07-11 stsp .Pp
1560 7d5807f4 2019-07-11 stsp The
1561 7d5807f4 2019-07-11 stsp .Cm got update
1562 7d5807f4 2019-07-11 stsp and
1563 7d5807f4 2019-07-11 stsp .Cm got commit
1564 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1565 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1566 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1567 818c7501 2019-07-11 stsp .Pp
1568 818c7501 2019-07-11 stsp The options for
1569 818c7501 2019-07-11 stsp .Cm got rebase
1570 818c7501 2019-07-11 stsp are as follows:
1571 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1572 818c7501 2019-07-11 stsp .It Fl a
1573 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1574 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1575 818c7501 2019-07-11 stsp .It Fl c
1576 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1577 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1578 e600f124 2021-03-21 stsp .It Fl l
1579 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
1580 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
1581 e600f124 2021-03-21 stsp reference namespace.
1582 e600f124 2021-03-21 stsp .Pp
1583 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
1584 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
1585 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
1586 e600f124 2021-03-21 stsp Given these object IDs,
1587 e600f124 2021-03-21 stsp the
1588 e600f124 2021-03-21 stsp .Cm got log
1589 e600f124 2021-03-21 stsp command with the
1590 e600f124 2021-03-21 stsp .Fl c
1591 e600f124 2021-03-21 stsp and
1592 e600f124 2021-03-21 stsp .Fl x
1593 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
1594 e600f124 2021-03-21 stsp and the
1595 e600f124 2021-03-21 stsp .Cm got branch
1596 e600f124 2021-03-21 stsp command with the
1597 e600f124 2021-03-21 stsp .Fl c
1598 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
1599 e600f124 2021-03-21 stsp .Pp
1600 e600f124 2021-03-21 stsp If a
1601 e600f124 2021-03-21 stsp .Ar branch
1602 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
1603 e600f124 2021-03-21 stsp branch.
1604 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
1605 e600f124 2021-03-21 stsp .Pp
1606 e600f124 2021-03-21 stsp If this option is used,
1607 e600f124 2021-03-21 stsp .Cm got rebase
1608 e600f124 2021-03-21 stsp does not require a work tree.
1609 e600f124 2021-03-21 stsp None of the other options can be used together with
1610 e600f124 2021-03-21 stsp .Fl l .
1611 643b85bc 2021-07-16 stsp .It Fl X
1612 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
1613 643b85bc 2021-07-16 stsp in the
1614 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
1615 643b85bc 2021-07-16 stsp reference namespace.
1616 643b85bc 2021-07-16 stsp .Pp
1617 643b85bc 2021-07-16 stsp If a
1618 643b85bc 2021-07-16 stsp .Ar branch
1619 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
1620 643b85bc 2021-07-16 stsp this branch.
1621 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
1622 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
1623 643b85bc 2021-07-16 stsp .Pp
1624 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
1625 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
1626 643b85bc 2021-07-16 stsp Git's garbage collector or
1627 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
1628 643b85bc 2021-07-16 stsp .Pp
1629 643b85bc 2021-07-16 stsp If this option is used,
1630 643b85bc 2021-07-16 stsp .Cm got rebase
1631 643b85bc 2021-07-16 stsp does not require a work tree.
1632 643b85bc 2021-07-16 stsp None of the other options can be used together with
1633 643b85bc 2021-07-16 stsp .Fl X .
1634 818c7501 2019-07-11 stsp .El
1635 818c7501 2019-07-11 stsp .It Cm rb
1636 818c7501 2019-07-11 stsp Short alias for
1637 818c7501 2019-07-11 stsp .Cm rebase .
1638 643b85bc 2021-07-16 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl f Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1639 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1640 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1641 6e54d307 2020-02-24 stsp .Pp
1642 6e54d307 2020-02-24 stsp Before starting a
1643 6e54d307 2020-02-24 stsp .Cm histedit
1644 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1645 6e54d307 2020-02-24 stsp .Cm got update -b
1646 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1647 6e54d307 2020-02-24 stsp current branch of the work tree.
1648 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1649 6e54d307 2020-02-24 stsp touched by the
1650 6e54d307 2020-02-24 stsp .Cm histedit
1651 6e54d307 2020-02-24 stsp operation.
1652 0ebf8283 2019-07-24 stsp .Pp
1653 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1654 6e54d307 2020-02-24 stsp must be set with
1655 6e54d307 2020-02-24 stsp .Cm got update -c
1656 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1657 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1658 6e54d307 2020-02-24 stsp by the
1659 6e54d307 2020-02-24 stsp .Cm histedit
1660 6e54d307 2020-02-24 stsp operation.
1661 6e54d307 2020-02-24 stsp .Pp
1662 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1663 0ebf8283 2019-07-24 stsp .Ar histedit script
1664 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1665 46fa4c83 2020-02-24 stsp command line, or generated with the
1666 466785b9 2020-12-10 jrick .Fl f
1667 466785b9 2020-12-10 jrick or
1668 083957f4 2020-02-24 stsp .Fl m
1669 466785b9 2020-12-10 jrick options.
1670 083957f4 2020-02-24 stsp .Pp
1671 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1672 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1673 0ebf8283 2019-07-24 stsp whitespace and an argument.
1674 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1675 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1676 0ebf8283 2019-07-24 stsp Lines which begin with the
1677 0ebf8283 2019-07-24 stsp .Sq #
1678 0ebf8283 2019-07-24 stsp character are ignored entirely.
1679 0ebf8283 2019-07-24 stsp .Pp
1680 0ebf8283 2019-07-24 stsp The available commands are as follows:
1681 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1682 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1683 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1684 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1685 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1686 0ebf8283 2019-07-24 stsp listed further below that will be used.
1687 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1688 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1689 0ebf8283 2019-07-24 stsp the commit on the previous line.
1690 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1691 0ebf8283 2019-07-24 stsp log message can be written.
1692 0ebf8283 2019-07-24 stsp .El
1693 0ebf8283 2019-07-24 stsp .Pp
1694 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1695 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1696 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1697 0ebf8283 2019-07-24 stsp .Pp
1698 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1699 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1700 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1701 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1702 498a90b7 2019-07-25 stsp switched to it.
1703 0ebf8283 2019-07-24 stsp .Pp
1704 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
1705 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
1706 e600f124 2021-03-21 stsp reference namespace.
1707 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
1708 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
1709 e600f124 2021-03-21 stsp .Cm got histedit -l
1710 e600f124 2021-03-21 stsp command.
1711 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
1712 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
1713 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1714 e600f124 2021-03-21 stsp .Pp
1715 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1716 0ebf8283 2019-07-24 stsp using the following status codes:
1717 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1718 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1719 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1720 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1721 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1722 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1723 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1724 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1725 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1726 0ebf8283 2019-07-24 stsp .El
1727 0ebf8283 2019-07-24 stsp .Pp
1728 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1729 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1730 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1731 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1732 0ebf8283 2019-07-24 stsp .Pp
1733 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1734 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1735 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1736 0ebf8283 2019-07-24 stsp .Pp
1737 0ebf8283 2019-07-24 stsp .Cm got histedit
1738 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1739 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1740 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1741 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1742 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1743 0ebf8283 2019-07-24 stsp to a single base commit with
1744 0ebf8283 2019-07-24 stsp .Cm got update .
1745 4ed9f614 2019-08-04 stsp If changes have been staged with
1746 4ed9f614 2019-08-04 stsp .Cm got stage ,
1747 bc3056e3 2019-08-18 stsp these changes must first be committed with
1748 4ed9f614 2019-08-04 stsp .Cm got commit
1749 4ed9f614 2019-08-04 stsp or unstaged with
1750 4ed9f614 2019-08-04 stsp .Cm got unstage .
1751 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1752 0ebf8283 2019-07-24 stsp committed with
1753 0ebf8283 2019-07-24 stsp .Cm got commit
1754 0ebf8283 2019-07-24 stsp or reverted with
1755 0ebf8283 2019-07-24 stsp .Cm got revert .
1756 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1757 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1758 0ebf8283 2019-07-24 stsp .Pp
1759 0ebf8283 2019-07-24 stsp The
1760 7ef62c4e 2020-02-24 stsp .Cm got update ,
1761 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1762 65db4ffb 2020-02-24 stsp and
1763 65db4ffb 2020-02-24 stsp .Cm got integrate
1764 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1765 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1766 0ebf8283 2019-07-24 stsp .Cm got commit
1767 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1768 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1769 0ebf8283 2019-07-24 stsp .Pp
1770 0ebf8283 2019-07-24 stsp The options for
1771 0ebf8283 2019-07-24 stsp .Cm got histedit
1772 0ebf8283 2019-07-24 stsp are as follows:
1773 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1774 0ebf8283 2019-07-24 stsp .It Fl a
1775 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1776 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1777 0ebf8283 2019-07-24 stsp .It Fl c
1778 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1779 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1780 466785b9 2020-12-10 jrick .It Fl f
1781 466785b9 2020-12-10 jrick Fold all commits into a single commit.
1782 466785b9 2020-12-10 jrick This option is a quick equivalent to a histedit script which folds all
1783 466785b9 2020-12-10 jrick commits, combining them all into one commit.
1784 2a78779e 2020-12-11 stsp The
1785 2a78779e 2020-12-11 stsp .Fl f
1786 2a78779e 2020-12-11 stsp option can only be used when starting a new histedit operation.
1787 466785b9 2020-12-10 jrick If this option is used, no other command-line arguments are allowed.
1788 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1789 ddbfac99 2020-02-24 stsp Use the specified
1790 ddbfac99 2020-02-24 stsp .Ar histedit-script
1791 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1792 ddbfac99 2020-02-24 stsp can be written.
1793 083957f4 2020-02-24 stsp .It Fl m
1794 083957f4 2020-02-24 stsp Edit log messages only.
1795 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1796 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1797 083957f4 2020-02-24 stsp The
1798 083957f4 2020-02-24 stsp .Fl m
1799 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1800 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1801 e600f124 2021-03-21 stsp .It Fl l
1802 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
1803 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
1804 e600f124 2021-03-21 stsp reference namespace.
1805 e600f124 2021-03-21 stsp .Pp
1806 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
1807 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
1808 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
1809 e600f124 2021-03-21 stsp Given these object IDs,
1810 e600f124 2021-03-21 stsp the
1811 e600f124 2021-03-21 stsp .Cm got log
1812 e600f124 2021-03-21 stsp command with the
1813 e600f124 2021-03-21 stsp .Fl c
1814 e600f124 2021-03-21 stsp and
1815 e600f124 2021-03-21 stsp .Fl x
1816 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
1817 e600f124 2021-03-21 stsp and the
1818 e600f124 2021-03-21 stsp .Cm got branch
1819 e600f124 2021-03-21 stsp command with the
1820 e600f124 2021-03-21 stsp .Fl c
1821 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
1822 e600f124 2021-03-21 stsp .Pp
1823 e600f124 2021-03-21 stsp If a
1824 e600f124 2021-03-21 stsp .Ar branch
1825 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
1826 e600f124 2021-03-21 stsp branch.
1827 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
1828 e600f124 2021-03-21 stsp .Pp
1829 e600f124 2021-03-21 stsp If this option is used,
1830 e600f124 2021-03-21 stsp .Cm got histedit
1831 e600f124 2021-03-21 stsp does not require a work tree.
1832 e600f124 2021-03-21 stsp None of the other options can be used together with
1833 e600f124 2021-03-21 stsp .Fl l .
1834 643b85bc 2021-07-16 stsp .It Fl X
1835 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
1836 643b85bc 2021-07-16 stsp in the
1837 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
1838 643b85bc 2021-07-16 stsp reference namespace.
1839 643b85bc 2021-07-16 stsp .Pp
1840 643b85bc 2021-07-16 stsp If a
1841 643b85bc 2021-07-16 stsp .Ar branch
1842 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
1843 643b85bc 2021-07-16 stsp this branch.
1844 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
1845 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
1846 643b85bc 2021-07-16 stsp .Pp
1847 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
1848 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
1849 643b85bc 2021-07-16 stsp Git's garbage collector or
1850 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
1851 643b85bc 2021-07-16 stsp .Pp
1852 643b85bc 2021-07-16 stsp If this option is used,
1853 643b85bc 2021-07-16 stsp .Cm got histedit
1854 643b85bc 2021-07-16 stsp does not require a work tree.
1855 643b85bc 2021-07-16 stsp None of the other options can be used together with
1856 643b85bc 2021-07-16 stsp .Fl X .
1857 818c7501 2019-07-11 stsp .El
1858 0ebf8283 2019-07-24 stsp .It Cm he
1859 0ebf8283 2019-07-24 stsp Short alias for
1860 0ebf8283 2019-07-24 stsp .Cm histedit .
1861 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1862 2822a352 2019-10-15 stsp Integrate the specified
1863 2822a352 2019-10-15 stsp .Ar branch
1864 2822a352 2019-10-15 stsp into the work tree's current branch.
1865 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1866 2822a352 2019-10-15 stsp .Ar branch ,
1867 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1868 2822a352 2019-10-15 stsp head commit of the integrated
1869 2822a352 2019-10-15 stsp .Ar branch .
1870 2822a352 2019-10-15 stsp .Pp
1871 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1872 2822a352 2019-10-15 stsp will be pointing at the same commit.
1873 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1874 2822a352 2019-10-15 stsp In case the integrated
1875 2822a352 2019-10-15 stsp .Ar branch
1876 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1877 2822a352 2019-10-15 stsp .Cm got branch -d .
1878 2822a352 2019-10-15 stsp .Pp
1879 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1880 2822a352 2019-10-15 stsp .Bl -column YXZ description
1881 2822a352 2019-10-15 stsp .It U Ta file was updated
1882 2822a352 2019-10-15 stsp .It D Ta file was deleted
1883 2822a352 2019-10-15 stsp .It A Ta new file was added
1884 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1885 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1886 2822a352 2019-10-15 stsp .El
1887 2822a352 2019-10-15 stsp .Pp
1888 2822a352 2019-10-15 stsp .Cm got integrate
1889 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1890 2822a352 2019-10-15 stsp Most importantly, the
1891 2822a352 2019-10-15 stsp .Ar branch
1892 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1893 2822a352 2019-10-15 stsp .Cm got rebase
1894 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1895 2822a352 2019-10-15 stsp resolve merge conflicts.
1896 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1897 2822a352 2019-10-15 stsp to a single base commit with
1898 2822a352 2019-10-15 stsp .Cm got update .
1899 2822a352 2019-10-15 stsp If changes have been staged with
1900 2822a352 2019-10-15 stsp .Cm got stage ,
1901 2822a352 2019-10-15 stsp these changes must first be committed with
1902 2822a352 2019-10-15 stsp .Cm got commit
1903 2822a352 2019-10-15 stsp or unstaged with
1904 2822a352 2019-10-15 stsp .Cm got unstage .
1905 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1906 2822a352 2019-10-15 stsp committed with
1907 2822a352 2019-10-15 stsp .Cm got commit
1908 2822a352 2019-10-15 stsp or reverted with
1909 2822a352 2019-10-15 stsp .Cm got revert .
1910 2822a352 2019-10-15 stsp .It Cm ig
1911 2822a352 2019-10-15 stsp Short alias for
1912 2822a352 2019-10-15 stsp .Cm integrate .
1913 35213c7c 2020-07-23 stsp .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl S Oc Op Ar path ...
1914 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1915 2db2652d 2019-08-07 stsp If no
1916 2db2652d 2019-08-07 stsp .Ar path
1917 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1918 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1919 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1920 4ed9f614 2019-08-04 stsp .Cm got status .
1921 4ed9f614 2019-08-04 stsp .Pp
1922 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1923 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1924 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1925 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1926 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1927 9d8b19a4 2019-08-04 stsp .El
1928 9d8b19a4 2019-08-04 stsp .Pp
1929 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1930 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1931 9d8b19a4 2019-08-04 stsp committed.
1932 9d8b19a4 2019-08-04 stsp .Pp
1933 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1934 4ed9f614 2019-08-04 stsp .Cm got commit ,
1935 4ed9f614 2019-08-04 stsp .Cm got status ,
1936 4ed9f614 2019-08-04 stsp and
1937 4ed9f614 2019-08-04 stsp .Cm got diff .
1938 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1939 4ed9f614 2019-08-04 stsp .Cm got commit
1940 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1941 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1942 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1943 4ed9f614 2019-08-04 stsp The
1944 4ed9f614 2019-08-04 stsp .Cm got status
1945 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1946 4ed9f614 2019-08-04 stsp The
1947 4ed9f614 2019-08-04 stsp .Cm got diff
1948 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1949 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1950 4ed9f614 2019-08-04 stsp The
1951 4ed9f614 2019-08-04 stsp .Cm got revert
1952 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1953 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1954 4ed9f614 2019-08-04 stsp .Pp
1955 4ed9f614 2019-08-04 stsp The options for
1956 4ed9f614 2019-08-04 stsp .Cm got stage
1957 4ed9f614 2019-08-04 stsp are as follows:
1958 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1959 4ed9f614 2019-08-04 stsp .It Fl l
1960 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1961 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1962 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1963 1dd86744 2019-08-12 anthony among the specified paths.
1964 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1965 dc424a06 2019-08-07 stsp .It Fl p
1966 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1967 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1968 dc424a06 2019-08-07 stsp .Dq y
1969 6d23ec10 2019-08-08 stsp (stage change),
1970 dc424a06 2019-08-07 stsp .Dq n
1971 6d23ec10 2019-08-08 stsp (reject change), and
1972 b353a198 2019-08-07 stsp .Dq q
1973 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1974 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1975 dc424a06 2019-08-07 stsp modified file content can be staged.
1976 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1977 6d23ec10 2019-08-08 stsp their entirety.
1978 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1979 dc424a06 2019-08-07 stsp With the
1980 dc424a06 2019-08-07 stsp .Fl p
1981 3a070a2b 2019-08-07 stsp option, read
1982 3a070a2b 2019-08-07 stsp .Dq y ,
1983 3a070a2b 2019-08-07 stsp .Dq n ,
1984 3a070a2b 2019-08-07 stsp and
1985 3a070a2b 2019-08-07 stsp .Dq q
1986 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1987 0e2f5884 2019-08-07 stsp .Ar response-script
1988 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1989 35213c7c 2020-07-23 stsp .It Fl S
1990 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
1991 af358f55 2020-07-23 stsp that is under version control.
1992 af358f55 2020-07-23 stsp By default,
1993 af358f55 2020-07-23 stsp .Cm got stage
1994 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
1995 35213c7c 2020-07-23 stsp As a precaution,
1996 35213c7c 2020-07-23 stsp .Nm
1997 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
1998 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
1999 af358f55 2020-07-23 stsp points outside of the work tree.
2000 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
2001 af358f55 2020-07-23 stsp .Dq make obj
2002 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
2003 af358f55 2020-07-23 stsp version control.
2004 4ed9f614 2019-08-04 stsp .El
2005 4ed9f614 2019-08-04 stsp .Pp
2006 4ed9f614 2019-08-04 stsp .Cm got stage
2007 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
2008 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
2009 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
2010 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
2011 4ed9f614 2019-08-04 stsp .Cm got update
2012 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
2013 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
2014 4ed9f614 2019-08-04 stsp .Pp
2015 4ed9f614 2019-08-04 stsp The
2016 4ed9f614 2019-08-04 stsp .Cm got update ,
2017 4ed9f614 2019-08-04 stsp .Cm got rebase ,
2018 4ed9f614 2019-08-04 stsp and
2019 4ed9f614 2019-08-04 stsp .Cm got histedit
2020 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
2021 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
2022 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
2023 4ed9f614 2019-08-04 stsp .Cm got unstage
2024 4ed9f614 2019-08-04 stsp before it can be updated with
2025 4ed9f614 2019-08-04 stsp .Cm got update ,
2026 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
2027 4ed9f614 2019-08-04 stsp .It Cm sg
2028 4ed9f614 2019-08-04 stsp Short alias for
2029 4ed9f614 2019-08-04 stsp .Cm stage .
2030 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2031 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
2032 4ed9f614 2019-08-04 stsp back into non-staged status.
2033 4ed9f614 2019-08-04 stsp If no
2034 4ed9f614 2019-08-04 stsp .Ar path
2035 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
2036 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
2037 4ed9f614 2019-08-04 stsp .Pp
2038 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2039 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
2040 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
2041 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
2042 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
2043 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
2044 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
2045 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2046 4ed9f614 2019-08-04 stsp .El
2047 2e1f37b0 2019-08-08 stsp .Pp
2048 2e1f37b0 2019-08-08 stsp The options for
2049 2e1f37b0 2019-08-08 stsp .Cm got unstage
2050 2e1f37b0 2019-08-08 stsp are as follows:
2051 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
2052 2e1f37b0 2019-08-08 stsp .It Fl p
2053 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
2054 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
2055 2e1f37b0 2019-08-08 stsp .Dq y
2056 2e1f37b0 2019-08-08 stsp (unstage change),
2057 2e1f37b0 2019-08-08 stsp .Dq n
2058 2e1f37b0 2019-08-08 stsp (keep change staged), and
2059 2e1f37b0 2019-08-08 stsp .Dq q
2060 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
2061 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
2062 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
2063 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
2064 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
2065 2e1f37b0 2019-08-08 stsp With the
2066 2e1f37b0 2019-08-08 stsp .Fl p
2067 2e1f37b0 2019-08-08 stsp option, read
2068 2e1f37b0 2019-08-08 stsp .Dq y ,
2069 2e1f37b0 2019-08-08 stsp .Dq n ,
2070 2e1f37b0 2019-08-08 stsp and
2071 2e1f37b0 2019-08-08 stsp .Dq q
2072 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
2073 2e1f37b0 2019-08-08 stsp .Ar response-script
2074 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
2075 2e1f37b0 2019-08-08 stsp .El
2076 4ed9f614 2019-08-04 stsp .It Cm ug
2077 4ed9f614 2019-08-04 stsp Short alias for
2078 4ed9f614 2019-08-04 stsp .Cm unstage .
2079 5be72254 2019-08-26 stsp .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2080 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
2081 896e9b6f 2019-08-26 stsp text format.
2082 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
2083 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
2084 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
2085 896e9b6f 2019-08-26 stsp .Pp
2086 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
2087 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
2088 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
2089 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
2090 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2091 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
2092 01073a5d 2019-08-22 stsp .Pp
2093 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
2094 896e9b6f 2019-08-26 stsp .Fl P
2095 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
2096 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
2097 896e9b6f 2019-08-26 stsp .Pp
2098 01073a5d 2019-08-22 stsp The options for
2099 01073a5d 2019-08-22 stsp .Cm got cat
2100 01073a5d 2019-08-22 stsp are as follows:
2101 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
2102 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
2103 896e9b6f 2019-08-26 stsp Look up paths in the specified
2104 896e9b6f 2019-08-26 stsp .Ar commit .
2105 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
2106 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
2107 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
2108 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
2109 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2110 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
2111 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
2112 01073a5d 2019-08-22 stsp Use the repository at the specified path.
2113 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
2114 01073a5d 2019-08-22 stsp working directory.
2115 01073a5d 2019-08-22 stsp If this directory is a
2116 01073a5d 2019-08-22 stsp .Nm
2117 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
2118 896e9b6f 2019-08-26 stsp .It Fl P
2119 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
2120 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
2121 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
2122 4ed9f614 2019-08-04 stsp .El
2123 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
2124 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
2125 b2118c49 2020-07-28 stsp See
2126 b2118c49 2020-07-28 stsp .Xr got-worktree 5
2127 b2118c49 2020-07-28 stsp for details.
2128 b2118c49 2020-07-28 stsp .Pp
2129 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
2130 b2118c49 2020-07-28 stsp current working directory.
2131 b2118c49 2020-07-28 stsp .Pp
2132 b2118c49 2020-07-28 stsp If one or more
2133 b2118c49 2020-07-28 stsp .Ar path
2134 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
2135 b2118c49 2020-07-28 stsp files located at or within these paths.
2136 b2118c49 2020-07-28 stsp If a
2137 b2118c49 2020-07-28 stsp .Ar path
2138 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
2139 b2118c49 2020-07-28 stsp for all tracked files.
2140 01073a5d 2019-08-22 stsp .El
2141 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
2142 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
2143 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
2144 74416c47 2019-05-09 stsp The author's name and email address for
2145 21a44f98 2019-07-15 stsp .Cm got commit
2146 21a44f98 2019-07-15 stsp and
2147 21a44f98 2019-07-15 stsp .Cm got import ,
2148 74416c47 2019-05-09 stsp for example:
2149 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2150 84792843 2019-08-09 stsp Because
2151 0e444aba 2019-08-08 stsp .Xr git 1
2152 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
2153 0e444aba 2019-08-08 stsp .Nm
2154 84792843 2019-08-09 stsp attempts to reject
2155 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
2156 84792843 2019-08-09 stsp environment variables with a missing email address.
2157 c9956ddf 2019-09-08 stsp .Pp
2158 50b0790e 2020-09-11 stsp .Ev GOT_AUTHOR will be overriden by configuration settings in
2159 50b0790e 2020-09-11 stsp .Xr got.conf 5
2160 50b0790e 2020-09-11 stsp or by Git's
2161 aba9c984 2019-09-08 stsp .Dv user.name
2162 aba9c984 2019-09-08 stsp and
2163 709ae9eb 2019-09-08 stsp .Dv user.email
2164 709ae9eb 2019-09-08 stsp configuration settings in the repository's
2165 aba9c984 2019-09-08 stsp .Pa .git/config
2166 50b0790e 2020-09-11 stsp file.
2167 257add31 2020-09-09 stsp The
2168 c9956ddf 2019-09-08 stsp .Dv user.name
2169 c9956ddf 2019-09-08 stsp and
2170 c9956ddf 2019-09-08 stsp .Dv user.email
2171 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
2172 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
2173 257add31 2020-09-09 stsp configuration file will only be used if neither
2174 257add31 2020-09-09 stsp .Xr got.conf 5
2175 257add31 2020-09-09 stsp nor the
2176 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
2177 257add31 2020-09-09 stsp environment variable provide author information.
2178 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
2179 23594da9 2019-05-13 stsp The editor spawned by
2180 8e7bd50a 2019-08-22 stsp .Cm got commit ,
2181 46215d2a 2020-09-11 stsp .Cm got histedit ,
2182 8e7bd50a 2019-08-22 stsp .Cm got import ,
2183 8e7bd50a 2019-08-22 stsp or
2184 8e7bd50a 2019-08-22 stsp .Cm got tag .
2185 5b735925 2020-09-15 stsp If not set, the
2186 5b735925 2020-09-15 stsp .Xr ed 1
2187 5b735925 2020-09-15 stsp text editor will be spawned in order to give
2188 5b735925 2020-09-15 stsp .Xr ed 1
2189 5b735925 2020-09-15 stsp the attention it deserves.
2190 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
2191 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
2192 b1ebc001 2019-08-13 stsp .Cm got log .
2193 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
2194 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
2195 74416c47 2019-05-09 stsp .El
2196 257add31 2020-09-09 stsp .Sh FILES
2197 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
2198 257add31 2020-09-09 stsp .It Pa got.conf
2199 257add31 2020-09-09 stsp Repository-wide configuration settings for
2200 257add31 2020-09-09 stsp .Nm .
2201 50b0790e 2020-09-11 stsp If present, a
2202 50b0790e 2020-09-11 stsp .Xr got.conf 5
2203 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
2204 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
2205 257add31 2020-09-09 stsp .Pa config
2206 257add31 2020-09-09 stsp file.
2207 50b0790e 2020-09-11 stsp .Pp
2208 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
2209 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
2210 50b0790e 2020-09-11 stsp .Nm .
2211 50b0790e 2020-09-11 stsp If present, a
2212 1795b260 2021-04-02 kn .Xr got.conf 5
2213 50b0790e 2020-09-11 stsp configuration file in the
2214 50b0790e 2020-09-11 stsp .Pa .got
2215 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
2216 50b0790e 2020-09-11 stsp the repository's
2217 50b0790e 2020-09-11 stsp .Xr got.conf 5
2218 50b0790e 2020-09-11 stsp configuration file and Git's
2219 50b0790e 2020-09-11 stsp .Pa config
2220 50b0790e 2020-09-11 stsp file.
2221 257add31 2020-09-09 stsp .El
2222 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
2223 5c860e29 2018-03-12 stsp .Ex -std got
2224 97925469 2018-03-17 stsp .Sh EXAMPLES
2225 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
2226 fa6e0e48 2019-05-23 stsp .Nm .
2227 fd039d72 2020-03-18 stsp .Pp
2228 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
2229 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
2230 fd039d72 2020-03-18 stsp .Pp
2231 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
2232 fa6e0e48 2019-05-23 stsp .Xr git 1 :
2233 d83d9d5c 2019-05-13 stsp .Pp
2234 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
2235 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
2236 fa6e0e48 2019-05-23 stsp .Pp
2237 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
2238 3ce1b845 2019-07-15 stsp .Nm
2239 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
2240 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
2241 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
2242 fa6e0e48 2019-05-23 stsp .Pp
2243 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
2244 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2245 3ce1b845 2019-07-15 stsp .Pp
2246 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
2247 3ce1b845 2019-07-15 stsp .Pp
2248 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
2249 fa6e0e48 2019-05-23 stsp .Pp
2250 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
2251 e70c17ce 2019-05-22 stsp .Pp
2252 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
2253 33aa809d 2019-08-08 stsp .Pp
2254 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
2255 081470ac 2020-08-13 stsp .Pp
2256 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
2257 081470ac 2020-08-13 stsp .Pp
2258 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
2259 e70c17ce 2019-05-22 stsp .Pp
2260 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
2261 33aa809d 2019-08-08 stsp .Pp
2262 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
2263 e70c17ce 2019-05-22 stsp .Pp
2264 4e759de4 2019-06-26 stsp .Dl $ got branch -l
2265 e70c17ce 2019-05-22 stsp .Pp
2266 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
2267 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
2268 d83d9d5c 2019-05-13 stsp which is forked off the
2269 d83d9d5c 2019-05-13 stsp .Dq master
2270 d83d9d5c 2019-05-13 stsp branch:
2271 d83d9d5c 2019-05-13 stsp .Pp
2272 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
2273 e70c17ce 2019-05-22 stsp .Pp
2274 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
2275 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
2276 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
2277 e70c17ce 2019-05-22 stsp .Pp
2278 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
2279 e70c17ce 2019-05-22 stsp .Pp
2280 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
2281 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
2282 fa6e0e48 2019-05-23 stsp .Pp
2283 fa6e0e48 2019-05-23 stsp .Dl $ got commit
2284 fa6e0e48 2019-05-23 stsp .Pp
2285 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
2286 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
2287 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
2288 fa6e0e48 2019-05-23 stsp .Pp
2289 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
2290 04e9dcf3 2020-04-18 stsp .Pp
2291 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
2292 04e9dcf3 2020-04-18 stsp .Xr patch 1
2293 04e9dcf3 2020-04-18 stsp could apply them in sequence:
2294 5b666081 2020-02-24 stsp .Pp
2295 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
2296 04e9dcf3 2020-04-18 stsp .Pp
2297 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
2298 5b666081 2020-02-24 stsp .Pp
2299 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
2300 5b666081 2020-02-24 stsp .Pp
2301 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
2302 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
2303 5b666081 2020-02-24 stsp .Pa sys/uvm :
2304 fa6e0e48 2019-05-23 stsp .Pp
2305 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
2306 5b666081 2020-02-24 stsp .Pp
2307 5b666081 2020-02-24 stsp And this command has the same effect:
2308 5b666081 2020-02-24 stsp .Pp
2309 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
2310 5b666081 2020-02-24 stsp .Pp
2311 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
2312 b2118c49 2020-07-28 stsp .Pp
2313 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
2314 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
2315 b2118c49 2020-07-28 stsp .Pp
2316 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
2317 e70c17ce 2019-05-22 stsp .Pp
2318 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
2319 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
2320 e70c17ce 2019-05-22 stsp .Pp
2321 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
2322 e70c17ce 2019-05-22 stsp with a pre-defined log message.
2323 e70c17ce 2019-05-22 stsp .Pp
2324 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
2325 95fc3404 2019-07-15 stsp .Pp
2326 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
2327 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
2328 1795b260 2021-04-02 kn .Pa /tmp/msg :
2329 bcbc2272 2020-05-20 stsp .Pp
2330 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
2331 bcbc2272 2020-05-20 stsp .Pp
2332 95fc3404 2019-07-15 stsp Update any work tree checked out from the
2333 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
2334 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
2335 95fc3404 2019-07-15 stsp .Pp
2336 95fc3404 2019-07-15 stsp .Dl $ got update
2337 ac90e726 2019-07-15 stsp .Pp
2338 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
2339 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
2340 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
2341 e70c17ce 2019-05-22 stsp .Pp
2342 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
2343 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
2344 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
2345 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
2346 ac90e726 2019-07-15 stsp .Pp
2347 469dd726 2020-03-20 stsp Fetch new upstream commits into the local repository's
2348 469dd726 2020-03-20 stsp .Dq origin/master
2349 469dd726 2020-03-20 stsp branch:
2350 fa6e0e48 2019-05-23 stsp .Pp
2351 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
2352 469dd726 2020-03-20 stsp .Dl $ got fetch
2353 469dd726 2020-03-20 stsp .Pp
2354 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
2355 469dd726 2020-03-20 stsp .Cm git clone --bare
2356 469dd726 2020-03-20 stsp the
2357 469dd726 2020-03-20 stsp .Xr git-fetch 1
2358 469dd726 2020-03-20 stsp command must be used instead:
2359 469dd726 2020-03-20 stsp .Pp
2360 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
2361 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
2362 fa6e0e48 2019-05-23 stsp .Pp
2363 469dd726 2020-03-20 stsp Rebase the local
2364 469dd726 2020-03-20 stsp .Dq master
2365 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
2366 469dd726 2020-03-20 stsp .Dq origin/master
2367 469dd726 2020-03-20 stsp branch:
2368 469dd726 2020-03-20 stsp .Pp
2369 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
2370 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
2371 469dd726 2020-03-20 stsp .Dl $ got rebase master
2372 469dd726 2020-03-20 stsp .Pp
2373 fa6e0e48 2019-05-23 stsp Rebase the
2374 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
2375 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
2376 fa6e0e48 2019-05-23 stsp .Dq master
2377 fa6e0e48 2019-05-23 stsp branch.
2378 fa6e0e48 2019-05-23 stsp .Pp
2379 818c7501 2019-07-11 stsp .Dl $ got update -b master
2380 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
2381 7d7ffedb 2019-07-14 stsp .Pp
2382 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
2383 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
2384 1dd86744 2019-08-12 anthony .Ox Ns 's
2385 1dd86744 2019-08-12 anthony CVS tree:
2386 7d7ffedb 2019-07-14 stsp .Pp
2387 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2388 7d7ffedb 2019-07-14 stsp .Pp
2389 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
2390 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
2391 0ebf8283 2019-07-24 stsp branch:
2392 0ebf8283 2019-07-24 stsp .Pp
2393 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
2394 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
2395 0ebf8283 2019-07-24 stsp .Dl $ got histedit
2396 bf390dec 2020-03-20 stsp .Pp
2397 bf390dec 2020-03-20 stsp In order to merge changes committed to the
2398 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
2399 bf390dec 2020-03-20 stsp branch back into the
2400 bf390dec 2020-03-20 stsp .Dq master
2401 bf390dec 2020-03-20 stsp branch, the
2402 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
2403 bf390dec 2020-03-20 stsp branch must first be rebased onto the
2404 bf390dec 2020-03-20 stsp .Dq master
2405 bf390dec 2020-03-20 stsp branch:
2406 bf390dec 2020-03-20 stsp .Pp
2407 bf390dec 2020-03-20 stsp .Dl $ got update -b master
2408 bf390dec 2020-03-20 stsp .Dl $ got rebase unified-buffer-cache
2409 bf390dec 2020-03-20 stsp .Pp
2410 bf390dec 2020-03-20 stsp Changes on the
2411 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
2412 bf390dec 2020-03-20 stsp branch can now be made visible on the
2413 bf390dec 2020-03-20 stsp .Dq master
2414 bf390dec 2020-03-20 stsp branch with
2415 bf390dec 2020-03-20 stsp .Cm got integrate .
2416 bf390dec 2020-03-20 stsp Because the rebase operation switched the work tree to the
2417 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
2418 bf390dec 2020-03-20 stsp branch, the work tree must be switched back to the
2419 bf390dec 2020-03-20 stsp .Dq master
2420 bf390dec 2020-03-20 stsp branch before the
2421 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
2422 bf390dec 2020-03-20 stsp branch can be integrated into
2423 bf390dec 2020-03-20 stsp .Dq master :
2424 ff2cf171 2019-07-28 stsp .Pp
2425 bf390dec 2020-03-20 stsp .Dl $ got update -b master
2426 bf390dec 2020-03-20 stsp .Dl $ got integrate unified-buffer-cache
2427 469dd726 2020-03-20 stsp .Pp
2428 469dd726 2020-03-20 stsp Additional steps may be necessary if local changes need to be pushed back
2429 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
2430 7b3fde24 2019-07-28 stsp .Cm git push .
2431 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
2432 469dd726 2020-03-20 stsp .Cm git clone --bare
2433 7848a0e1 2020-03-19 stsp instead of
2434 7848a0e1 2020-03-19 stsp .Cm got clone ,
2435 ff2cf171 2019-07-28 stsp a Git
2436 ff2cf171 2019-07-28 stsp .Dq refspec
2437 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
2438 ff2cf171 2019-07-28 stsp into the
2439 ff2cf171 2019-07-28 stsp .Dq refs/remotes
2440 ff2cf171 2019-07-28 stsp namespace of the local repository.
2441 1795b260 2021-04-02 kn This can be achieved by setting Git's
2442 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
2443 ff2cf171 2019-07-28 stsp configuration variable to the value
2444 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
2445 ff2cf171 2019-07-28 stsp with the
2446 ff2cf171 2019-07-28 stsp .Cm git config
2447 ff2cf171 2019-07-28 stsp command:
2448 ff2cf171 2019-07-28 stsp .Pp
2449 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
2450 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2451 eac81709 2020-03-21 stsp .Pp
2452 469dd726 2020-03-20 stsp Additionally, the
2453 469dd726 2020-03-20 stsp .Dq mirror
2454 469dd726 2020-03-20 stsp option must be disabled:
2455 ff2cf171 2019-07-28 stsp .Pp
2456 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
2457 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
2458 469dd726 2020-03-20 stsp .Pp
2459 ff2cf171 2019-07-28 stsp Alternatively, the following
2460 469dd726 2020-03-20 stsp .Xr git-fetch 1
2461 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
2462 ff2cf171 2019-07-28 stsp .Pa config
2463 ff2cf171 2019-07-28 stsp file:
2464 0ebf8283 2019-07-24 stsp .Pp
2465 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
2466 ff2cf171 2019-07-28 stsp .Dl url = ...
2467 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2468 469dd726 2020-03-20 stsp .Dl mirror = false
2469 ff2cf171 2019-07-28 stsp .Pp
2470 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
2471 ff2cf171 2019-07-28 stsp .Dq refs/heads
2472 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
2473 ff2cf171 2019-07-28 stsp .Cm got checkout
2474 ff2cf171 2019-07-28 stsp and, if needed, created with
2475 ff2cf171 2019-07-28 stsp .Cm got branch .
2476 ff2cf171 2019-07-28 stsp .Pp
2477 ff2cf171 2019-07-28 stsp Branches in the
2478 ff2cf171 2019-07-28 stsp .Dq remotes/origin
2479 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
2480 ff2cf171 2019-07-28 stsp repository with
2481 469dd726 2020-03-20 stsp .Cm got fetch
2482 469dd726 2020-03-20 stsp or
2483 469dd726 2020-03-20 stsp .Xr git-fetch 1
2484 469dd726 2020-03-20 stsp without extra command line arguments:
2485 ff2cf171 2019-07-28 stsp .Pp
2486 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
2487 469dd726 2020-03-20 stsp .Dl $ git fetch
2488 ff2cf171 2019-07-28 stsp .Pp
2489 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
2490 ff2cf171 2019-07-28 stsp .Dq master
2491 7b0db533 2020-02-04 stsp branch, the
2492 ff2cf171 2019-07-28 stsp .Dq master
2493 ff2cf171 2019-07-28 stsp branch must be rebased onto the
2494 ff2cf171 2019-07-28 stsp .Dq origin/master
2495 7b0db533 2020-02-04 stsp branch.
2496 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
2497 ff2cf171 2019-07-28 stsp .Pp
2498 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
2499 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
2500 083957f4 2020-02-24 stsp .Pp
2501 083957f4 2020-02-24 stsp On the
2502 083957f4 2020-02-24 stsp .Dq master
2503 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
2504 083957f4 2020-02-24 stsp .Dq OK
2505 083957f4 2020-02-24 stsp by other developers and any other important new information:
2506 ff2cf171 2019-07-28 stsp .Pp
2507 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
2508 083957f4 2020-02-24 stsp .Dl $ got histedit -m
2509 083957f4 2020-02-24 stsp .Pp
2510 7b0db533 2020-02-04 stsp Local changes on the
2511 ff2cf171 2019-07-28 stsp .Dq master
2512 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
2513 ff2cf171 2019-07-28 stsp repository with
2514 ff2cf171 2019-07-28 stsp .Cm git push :
2515 ff2cf171 2019-07-28 stsp .Pp
2516 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
2517 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
2518 5c860e29 2018-03-12 stsp .Sh SEE ALSO
2519 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
2520 2312fc47 2019-07-15 stsp .Xr tog 1 ,
2521 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
2522 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
2523 257add31 2020-09-09 stsp .Xr got.conf 5
2524 1a208aaf 2018-04-01 stsp .Sh AUTHORS
2525 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
2526 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
2527 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
2528 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
2529 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
2530 fa6e0e48 2019-05-23 stsp .Nm
2531 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
2532 1795b260 2021-04-02 kn .Pp
2533 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
2534 fa6e0e48 2019-05-23 stsp .Xr git 1
2535 cc63216e 2020-12-26 stsp to perform some tasks.
2536 cc63216e 2020-12-26 stsp In particular:
2537 cc63216e 2020-12-26 stsp .Bl -bullet
2538 cc63216e 2020-12-26 stsp .It
2539 cc63216e 2020-12-26 stsp Reading from remote repositories over HTTP or HTTPS protocols requires
2540 cc63216e 2020-12-26 stsp .Xr git-clone 1
2541 cc63216e 2020-12-26 stsp and
2542 cc63216e 2020-12-26 stsp .Xr git-fetch 1 .
2543 cc63216e 2020-12-26 stsp .It
2544 cc63216e 2020-12-26 stsp Writing to remote repositories, over any protocol, requires
2545 cc63216e 2020-12-26 stsp .Xr git-push 1 .
2546 cc63216e 2020-12-26 stsp .It
2547 cc63216e 2020-12-26 stsp The creation of merge commits, i.e. commits with two or more parent commits,
2548 cc63216e 2020-12-26 stsp requires
2549 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
2550 cc63216e 2020-12-26 stsp .It
2551 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
2552 cc63216e 2020-12-26 stsp .Cm got
2553 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
2554 cc63216e 2020-12-26 stsp .Xr git 1
2555 cc63216e 2020-12-26 stsp will usually produce better results.
2556 cc63216e 2020-12-26 stsp .El