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 2f1457c6 2021-08-27 stsp command creates references in this namespace only.
1018 2f1457c6 2021-08-27 stsp .Pp
1019 2f1457c6 2021-08-27 stsp When deleting branches the specified
1020 2f1457c6 2021-08-27 stsp .Ar name
1021 2f1457c6 2021-08-27 stsp is searched in the
1022 2f1457c6 2021-08-27 stsp .Dq refs/heads
1023 2f1457c6 2021-08-27 stsp reference namespace first.
1024 2f1457c6 2021-08-27 stsp If no corresponding branch is found the
1025 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1026 2f1457c6 2021-08-27 stsp namespace will be searched next.
1027 4e759de4 2019-06-26 stsp .Pp
1028 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1029 ad89fa31 2019-10-04 stsp work tree's current branch.
1030 da76fce2 2020-02-24 stsp .Pp
1031 a74f7e83 2019-11-10 stsp If a
1032 a74f7e83 2019-11-10 stsp .Ar name
1033 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1034 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1035 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1036 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1037 4e759de4 2019-06-26 stsp .Pp
1038 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1039 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1040 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1041 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1042 da76fce2 2020-02-24 stsp would do.
1043 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1044 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1045 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1046 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1047 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1048 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1049 da76fce2 2020-02-24 stsp .It A Ta new file was added
1050 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1051 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1052 da76fce2 2020-02-24 stsp .El
1053 da76fce2 2020-02-24 stsp .Pp
1054 4e759de4 2019-06-26 stsp The options for
1055 4e759de4 2019-06-26 stsp .Cm got branch
1056 4e759de4 2019-06-26 stsp are as follows:
1057 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
1058 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1059 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1060 a74f7e83 2019-11-10 stsp .Ar commit .
1061 a74f7e83 2019-11-10 stsp The expected
1062 a74f7e83 2019-11-10 stsp .Ar commit
1063 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
1064 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
1065 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
1066 4e759de4 2019-06-26 stsp Use the repository at the specified path.
1067 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
1068 4e759de4 2019-06-26 stsp working directory.
1069 4e759de4 2019-06-26 stsp If this directory is a
1070 4e759de4 2019-06-26 stsp .Nm
1071 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
1072 4e759de4 2019-06-26 stsp .It Fl l
1073 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1074 34d4e04c 2021-02-08 stsp repositories' branches in the
1075 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1076 34d4e04c 2021-02-08 stsp reference namespace.
1077 34d4e04c 2021-02-08 stsp .Pp
1078 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1079 ba882ee3 2019-07-11 stsp with one the following annotations:
1080 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1081 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
1082 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
1083 ba882ee3 2019-07-11 stsp .El
1084 4e759de4 2019-06-26 stsp .It Fl d Ar name
1085 2f1457c6 2021-08-27 stsp Delete the branch with the specified
1086 2f1457c6 2021-08-27 stsp .Ar name
1087 2f1457c6 2021-08-27 stsp from the
1088 2f1457c6 2021-08-27 stsp .Dq refs/heads
1089 2f1457c6 2021-08-27 stsp or
1090 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1091 2f1457c6 2021-08-27 stsp reference namespace.
1092 2f1457c6 2021-08-27 stsp .Pp
1093 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
1094 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
1095 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
1096 e6786710 2021-07-03 stsp Git's garbage collector or
1097 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1098 da76fce2 2020-02-24 stsp .It Fl n
1099 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
1100 5de5890b 2018-10-18 stsp .El
1101 97b3a7be 2019-07-09 stsp .It Cm br
1102 97b3a7be 2019-07-09 stsp Short alias for
1103 97b3a7be 2019-07-09 stsp .Cm branch .
1104 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
1105 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1106 8e7bd50a 2019-08-22 stsp .Pp
1107 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1108 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1109 8e7bd50a 2019-08-22 stsp reference namespace.
1110 8e7bd50a 2019-08-22 stsp The
1111 8e7bd50a 2019-08-22 stsp .Cm got tag
1112 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1113 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1114 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1115 8e7bd50a 2019-08-22 stsp .Pp
1116 80106605 2020-02-24 stsp Attempt to create a tag with the given
1117 8e7bd50a 2019-08-22 stsp .Ar name ,
1118 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1119 8e7bd50a 2019-08-22 stsp .Ar commit .
1120 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1121 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1122 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1123 8e7bd50a 2019-08-22 stsp .Pp
1124 8e7bd50a 2019-08-22 stsp The options for
1125 8e7bd50a 2019-08-22 stsp .Cm got tag
1126 8e7bd50a 2019-08-22 stsp are as follows:
1127 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1128 80106605 2020-02-24 stsp .It Fl c Ar commit
1129 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1130 80106605 2020-02-24 stsp .Ar commit .
1131 80106605 2020-02-24 stsp The expected
1132 80106605 2020-02-24 stsp .Ar commit
1133 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
1134 80106605 2020-02-24 stsp will be resolved to a commit ID.
1135 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1136 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1137 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
1138 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
1139 8e7bd50a 2019-08-22 stsp Without the
1140 8e7bd50a 2019-08-22 stsp .Fl m
1141 8e7bd50a 2019-08-22 stsp option,
1142 3a62228f 2019-11-08 stsp .Cm got tag
1143 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
1144 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
1145 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
1146 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1147 8e7bd50a 2019-08-22 stsp working directory.
1148 8e7bd50a 2019-08-22 stsp If this directory is a
1149 8e7bd50a 2019-08-22 stsp .Nm
1150 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1151 8e7bd50a 2019-08-22 stsp .It Fl l
1152 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
1153 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
1154 8e7bd50a 2019-08-22 stsp .El
1155 8e7bd50a 2019-08-22 stsp .Pp
1156 8e7bd50a 2019-08-22 stsp By design, the
1157 8e7bd50a 2019-08-22 stsp .Cm got tag
1158 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1159 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1160 8e7bd50a 2019-08-22 stsp .Cm got ref
1161 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1162 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1163 8e7bd50a 2019-08-22 stsp another repository.
1164 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1165 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1166 d00136be 2019-03-26 stsp repository in the next commit.
1167 ff56836b 2021-07-08 stsp By default, files which match a
1168 ff56836b 2021-07-08 stsp .Cm got status
1169 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1170 4e68cba3 2019-11-23 stsp .Pp
1171 4e68cba3 2019-11-23 stsp The options for
1172 4e68cba3 2019-11-23 stsp .Cm got add
1173 4e68cba3 2019-11-23 stsp are as follows:
1174 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1175 4e68cba3 2019-11-23 stsp .It Fl R
1176 4e68cba3 2019-11-23 stsp Permit recursion into directories.
1177 4e68cba3 2019-11-23 stsp If this option is not specified,
1178 4e68cba3 2019-11-23 stsp .Cm got add
1179 4e68cba3 2019-11-23 stsp will refuse to run if a specified
1180 4e68cba3 2019-11-23 stsp .Ar path
1181 4e68cba3 2019-11-23 stsp is a directory.
1182 022fae89 2019-12-06 tracey .It Fl I
1183 ff56836b 2021-07-08 stsp Add files even if they match a
1184 022fae89 2019-12-06 tracey .Cm got status
1185 022fae89 2019-12-06 tracey ignore pattern.
1186 4e68cba3 2019-11-23 stsp .El
1187 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 ...
1188 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1189 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1190 2ec1f75b 2019-03-26 stsp .Pp
1191 2ec1f75b 2019-03-26 stsp The options for
1192 86d25a1b 2019-07-11 stsp .Cm got remove
1193 2ec1f75b 2019-03-26 stsp are as follows:
1194 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1195 2ec1f75b 2019-03-26 stsp .It Fl f
1196 bd81cfb7 2020-04-19 stsp Perform the operation even if a file contains local modifications.
1197 70e3e7f5 2019-12-13 tracey .It Fl k
1198 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1199 f2a9dc41 2019-12-13 tracey .It Fl R
1200 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1201 f2a9dc41 2019-12-13 tracey If this option is not specified,
1202 f2a9dc41 2019-12-13 tracey .Cm got remove
1203 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1204 f2a9dc41 2019-12-13 tracey .Ar path
1205 f2a9dc41 2019-12-13 tracey is a directory.
1206 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1207 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1208 766841c2 2020-08-13 stsp single-character status codes contained in the
1209 766841c2 2020-08-13 stsp .Ar status-codes
1210 766841c2 2020-08-13 stsp argument.
1211 766841c2 2020-08-13 stsp The following status codes may be specified:
1212 766841c2 2020-08-13 stsp .Bl -column YXZ description
1213 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1214 766841c2 2020-08-13 stsp .Fl f
1215 766841c2 2020-08-13 stsp option)
1216 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1217 766841c2 2020-08-13 stsp .El
1218 d0eebce4 2019-03-11 stsp .El
1219 648e4ef7 2019-07-09 stsp .It Cm rm
1220 648e4ef7 2019-07-09 stsp Short alias for
1221 648e4ef7 2019-07-09 stsp .Cm remove .
1222 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 ...
1223 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
1224 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
1225 1dd86744 2019-08-12 anthony work tree's base commit.
1226 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
1227 a129376b 2019-03-28 stsp .Cm got revert !
1228 a129376b 2019-03-28 stsp .Pp
1229 e20a8b6f 2019-06-04 stsp If a file was added with
1230 a129376b 2019-03-28 stsp .Cm got add
1231 a129376b 2019-03-28 stsp it will become an unversioned file again.
1232 e20a8b6f 2019-06-04 stsp If a file was deleted with
1233 86d25a1b 2019-07-11 stsp .Cm got remove
1234 a129376b 2019-03-28 stsp it will be restored.
1235 0f6d7415 2019-08-08 stsp .Pp
1236 0f6d7415 2019-08-08 stsp The options for
1237 0f6d7415 2019-08-08 stsp .Cm got revert
1238 0f6d7415 2019-08-08 stsp are as follows:
1239 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
1240 33aa809d 2019-08-08 stsp .It Fl p
1241 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
1242 33aa809d 2019-08-08 stsp changes to revert based on
1243 33aa809d 2019-08-08 stsp .Dq y
1244 33aa809d 2019-08-08 stsp (revert change),
1245 33aa809d 2019-08-08 stsp .Dq n
1246 33aa809d 2019-08-08 stsp (keep change), and
1247 33aa809d 2019-08-08 stsp .Dq q
1248 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
1249 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
1250 33aa809d 2019-08-08 stsp modified file content can be reverted.
1251 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
1252 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
1253 33aa809d 2019-08-08 stsp With the
1254 33aa809d 2019-08-08 stsp .Fl p
1255 33aa809d 2019-08-08 stsp option, read
1256 33aa809d 2019-08-08 stsp .Dq y ,
1257 33aa809d 2019-08-08 stsp .Dq n ,
1258 33aa809d 2019-08-08 stsp and
1259 33aa809d 2019-08-08 stsp .Dq q
1260 33aa809d 2019-08-08 stsp responses line-by-line from the specified
1261 33aa809d 2019-08-08 stsp .Ar response-script
1262 33aa809d 2019-08-08 stsp file instead of prompting interactively.
1263 0f6d7415 2019-08-08 stsp .It Fl R
1264 0f6d7415 2019-08-08 stsp Permit recursion into directories.
1265 0f6d7415 2019-08-08 stsp If this option is not specified,
1266 0f6d7415 2019-08-08 stsp .Cm got revert
1267 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1268 0f6d7415 2019-08-08 stsp .Ar path
1269 0f6d7415 2019-08-08 stsp is a directory.
1270 0f6d7415 2019-08-08 stsp .El
1271 97b3a7be 2019-07-09 stsp .It Cm rv
1272 97b3a7be 2019-07-09 stsp Short alias for
1273 97b3a7be 2019-07-09 stsp .Cm revert .
1274 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 ...
1275 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1276 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1277 5c1e53bc 2019-07-28 stsp If no
1278 90e8619e 2019-07-25 stsp .Ar path
1279 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1280 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1281 15cd91f7 2019-05-12 stsp .Pp
1282 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1283 1dd86744 2019-08-12 anthony .Cm got stage ,
1284 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1285 4ed9f614 2019-08-04 stsp have not been staged.
1286 4ed9f614 2019-08-04 stsp .Pp
1287 28cf319f 2021-01-28 stsp .Cm got commit
1288 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
1289 28cf319f 2021-01-28 stsp unless the
1290 28cf319f 2021-01-28 stsp .Fl m
1291 28cf319f 2021-01-28 stsp option is used
1292 28cf319f 2021-01-28 stsp or the
1293 28cf319f 2021-01-28 stsp .Fl F
1294 28cf319f 2021-01-28 stsp and
1295 28cf319f 2021-01-28 stsp .Fl N
1296 28cf319f 2021-01-28 stsp options are used together.
1297 28cf319f 2021-01-28 stsp .Pp
1298 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1299 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1300 15cd91f7 2019-05-12 stsp .It M Ta modified file
1301 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1302 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1303 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1304 15cd91f7 2019-05-12 stsp .El
1305 15cd91f7 2019-05-12 stsp .Pp
1306 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1307 996d5ccd 2019-08-05 stsp recorded base commit.
1308 15cd91f7 2019-05-12 stsp Some
1309 15cd91f7 2019-05-12 stsp .Nm
1310 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1311 15cd91f7 2019-05-12 stsp multiple base commits.
1312 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1313 47ec7be7 2019-05-12 stsp .Cm got update
1314 47ec7be7 2019-05-12 stsp across the entire work tree.
1315 15cd91f7 2019-05-12 stsp .Pp
1316 15cd91f7 2019-05-12 stsp The
1317 15cd91f7 2019-05-12 stsp .Cm got commit
1318 15cd91f7 2019-05-12 stsp command requires the
1319 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1320 aba9c984 2019-09-08 stsp environment variable to be set,
1321 257add31 2020-09-09 stsp unless an author has been configured in
1322 257add31 2020-09-09 stsp .Xr got.conf 5
1323 257add31 2020-09-09 stsp or Git's
1324 aba9c984 2019-09-08 stsp .Dv user.name
1325 aba9c984 2019-09-08 stsp and
1326 709ae9eb 2019-09-08 stsp .Dv user.email
1327 709ae9eb 2019-09-08 stsp configuration settings can be
1328 aba9c984 2019-09-08 stsp obtained from the repository's
1329 aba9c984 2019-09-08 stsp .Pa .git/config
1330 c9956ddf 2019-09-08 stsp file or from Git's global
1331 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1332 c9956ddf 2019-09-08 stsp configuration file.
1333 74416c47 2019-05-09 stsp .Pp
1334 74416c47 2019-05-09 stsp The options for
1335 74416c47 2019-05-09 stsp .Cm got commit
1336 74416c47 2019-05-09 stsp are as follows:
1337 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1338 28cf319f 2021-01-28 stsp .It Fl F Ar path
1339 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
1340 28cf319f 2021-01-28 stsp .Ar path
1341 28cf319f 2021-01-28 stsp when creating the new commit.
1342 28cf319f 2021-01-28 stsp .Cm got commit
1343 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
1344 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
1345 28cf319f 2021-01-28 stsp Cannot be used together with the
1346 23594da9 2019-05-13 stsp .Fl m
1347 28cf319f 2021-01-28 stsp option.
1348 28cf319f 2021-01-28 stsp .It Fl m Ar message
1349 28cf319f 2021-01-28 stsp Use the specified log message when creating the new commit.
1350 28cf319f 2021-01-28 stsp Cannot be used together with the
1351 28cf319f 2021-01-28 stsp .Fl F
1352 28cf319f 2021-01-28 stsp option.
1353 28cf319f 2021-01-28 stsp .It Fl N
1354 28cf319f 2021-01-28 stsp This option prevents
1355 23594da9 2019-05-13 stsp .Cm got commit
1356 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
1357 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
1358 28cf319f 2021-01-28 stsp .Fl F
1359 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
1360 35213c7c 2020-07-23 stsp .It Fl S
1361 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
1362 af358f55 2020-07-23 stsp that is under version control.
1363 af358f55 2020-07-23 stsp By default,
1364 af358f55 2020-07-23 stsp .Cm got commit
1365 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
1366 35213c7c 2020-07-23 stsp As a precaution,
1367 35213c7c 2020-07-23 stsp .Nm
1368 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
1369 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
1370 af358f55 2020-07-23 stsp points outside of the work tree.
1371 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
1372 af358f55 2020-07-23 stsp .Dq make obj
1373 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
1374 af358f55 2020-07-23 stsp version control.
1375 2ec1f75b 2019-03-26 stsp .El
1376 cfce0458 2019-07-28 stsp .Pp
1377 cfce0458 2019-07-28 stsp .Cm got commit
1378 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1379 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1380 916f288c 2019-07-30 stsp .Dq refs/heads/
1381 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1382 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1383 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1384 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1385 cfce0458 2019-07-28 stsp .Cm got update
1386 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1387 cfce0458 2019-07-28 stsp in the repository.
1388 97b3a7be 2019-07-09 stsp .It Cm ci
1389 97b3a7be 2019-07-09 stsp Short alias for
1390 97b3a7be 2019-07-09 stsp .Cm commit .
1391 f8a36e22 2021-08-26 stsp .It Cm send Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Ar branch Oc Oo Fl f Oc Oo Fl r Ar repository-path Oc Oo Fl t Ar tag Oc Oo Fl T Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository
1392 f8a36e22 2021-08-26 stsp Send new changes to a remote repository.
1393 f8a36e22 2021-08-26 stsp If no
1394 f8a36e22 2021-08-26 stsp .Ar remote-repository
1395 f8a36e22 2021-08-26 stsp is specified,
1396 f8a36e22 2021-08-26 stsp .Dq origin
1397 f8a36e22 2021-08-26 stsp will be used.
1398 f8a36e22 2021-08-26 stsp The remote repository's URL is obtained from the corresponding entry in
1399 f8a36e22 2021-08-26 stsp .Xr got.conf 5
1400 f8a36e22 2021-08-26 stsp or Git's
1401 f8a36e22 2021-08-26 stsp .Pa config
1402 f8a36e22 2021-08-26 stsp file of the local repository, as created by
1403 f8a36e22 2021-08-26 stsp .Cm got clone .
1404 f8a36e22 2021-08-26 stsp .Pp
1405 f8a36e22 2021-08-26 stsp All objects corresponding to new changes will be written to a temporary
1406 f8a36e22 2021-08-26 stsp pack file which is then uploaded to the server.
1407 f8a36e22 2021-08-26 stsp Upon success, references in the
1408 f8a36e22 2021-08-26 stsp .Dq refs/remotes/
1409 f8a36e22 2021-08-26 stsp reference namespace of the local repository will be updated to point at
1410 f8a36e22 2021-08-26 stsp the commits which have been sent.
1411 f8a36e22 2021-08-26 stsp .Pp
1412 f8a36e22 2021-08-26 stsp By default, changes will only be sent if they are based on up-to-date
1413 f8a36e22 2021-08-26 stsp copies of relevant branches in the remote repository.
1414 fd44090b 2021-08-26 stsp If any changes to be sent are based on out-of-date copies or would
1415 fd44090b 2021-08-26 stsp otherwise break linear history of existing branches, new changes must
1416 fd44090b 2021-08-26 stsp be fetched from the server with
1417 f8a36e22 2021-08-26 stsp .Cm got fetch
1418 f8a36e22 2021-08-26 stsp and local branches must be rebased with
1419 f8a36e22 2021-08-26 stsp .Cm got rebase
1420 f8a36e22 2021-08-26 stsp before
1421 f8a36e22 2021-08-26 stsp .Cm got send
1422 f8a36e22 2021-08-26 stsp can succeed.
1423 fd44090b 2021-08-26 stsp The
1424 fd44090b 2021-08-26 stsp .Fl f
1425 fd44090b 2021-08-26 stsp option can be used to make exceptions to these requirements.
1426 f8a36e22 2021-08-26 stsp .Pp
1427 f8a36e22 2021-08-26 stsp The options for
1428 f8a36e22 2021-08-26 stsp .Cm got send
1429 f8a36e22 2021-08-26 stsp are as follows:
1430 f8a36e22 2021-08-26 stsp .Bl -tag -width Ds
1431 f8a36e22 2021-08-26 stsp .It Fl a
1432 f8a36e22 2021-08-26 stsp Send all branches from the local repository's
1433 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1434 f8a36e22 2021-08-26 stsp reference namespace.
1435 f8a36e22 2021-08-26 stsp The
1436 f8a36e22 2021-08-26 stsp .Fl a
1437 f8a36e22 2021-08-26 stsp option is equivalent to listing all branches with multiple
1438 f8a36e22 2021-08-26 stsp .Fl b
1439 f8a36e22 2021-08-26 stsp options.
1440 f8a36e22 2021-08-26 stsp Cannot be used together with the
1441 f8a36e22 2021-08-26 stsp .Fl b
1442 f8a36e22 2021-08-26 stsp option.
1443 f8a36e22 2021-08-26 stsp .It Fl b Ar branch
1444 f8a36e22 2021-08-26 stsp Send the specified
1445 f8a36e22 2021-08-26 stsp .Ar branch
1446 f8a36e22 2021-08-26 stsp from the local repository's
1447 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1448 f8a36e22 2021-08-26 stsp reference namespace.
1449 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1450 f8a36e22 2021-08-26 stsp to send.
1451 f8a36e22 2021-08-26 stsp If this option is not specified, default to the work tree's current branch
1452 f8a36e22 2021-08-26 stsp if invoked in a work tree, or to the repository's HEAD reference.
1453 f8a36e22 2021-08-26 stsp Cannot be used together with the
1454 f8a36e22 2021-08-26 stsp .Fl a
1455 f8a36e22 2021-08-26 stsp option.
1456 f8a36e22 2021-08-26 stsp .It Fl d Ar branch
1457 f8a36e22 2021-08-26 stsp Delete the specified
1458 f8a36e22 2021-08-26 stsp .Ar branch
1459 f8a36e22 2021-08-26 stsp from the remote repository's
1460 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1461 f8a36e22 2021-08-26 stsp reference namespace.
1462 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1463 f8a36e22 2021-08-26 stsp to delete.
1464 f8a36e22 2021-08-26 stsp .Pp
1465 f8a36e22 2021-08-26 stsp Only references are deleted.
1466 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to deleted branches
1467 f8a36e22 2021-08-26 stsp may become subject to deletion by Git's garbage collector running on
1468 f8a36e22 2021-08-26 stsp the server.
1469 f8a36e22 2021-08-26 stsp .Pp
1470 f8a36e22 2021-08-26 stsp Requesting deletion of branches results in an error if the server
1471 fd44090b 2021-08-26 stsp does not support this feature or disallows the deletion of branches
1472 fd44090b 2021-08-26 stsp based on its configuration.
1473 f8a36e22 2021-08-26 stsp .It Fl f
1474 fd44090b 2021-08-26 stsp Attempt to force the server to overwrite existing branches or tags
1475 fd44090b 2021-08-26 stsp in the remote repository, even when
1476 fd44090b 2021-08-26 stsp .Cm got fetch
1477 fd44090b 2021-08-26 stsp and
1478 fd44090b 2021-08-26 stsp .Cm got rebase
1479 fd44090b 2021-08-26 stsp would usually be required before changes can be sent.
1480 f8a36e22 2021-08-26 stsp The server may reject forced requests regardless, depending on its
1481 f8a36e22 2021-08-26 stsp configuration.
1482 f8a36e22 2021-08-26 stsp .Pp
1483 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to overwritten branches
1484 f8a36e22 2021-08-26 stsp or tags may become subject to deletion by Git's garbage collector running
1485 f8a36e22 2021-08-26 stsp on the server.
1486 f8a36e22 2021-08-26 stsp .Pp
1487 f8a36e22 2021-08-26 stsp The
1488 f8a36e22 2021-08-26 stsp .Dq refs/tags
1489 f8a36e22 2021-08-26 stsp reference namespace is globally shared between all repositories.
1490 f8a36e22 2021-08-26 stsp Use of the
1491 f8a36e22 2021-08-26 stsp .Fl f
1492 f8a36e22 2021-08-26 stsp option to overwrite tags is discouraged because it can lead to
1493 f8a36e22 2021-08-26 stsp inconsistencies between the tags present in different repositories.
1494 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1495 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1496 f8a36e22 2021-08-26 stsp .Pp
1497 f8a36e22 2021-08-26 stsp Use of the
1498 f8a36e22 2021-08-26 stsp .Fl f
1499 f8a36e22 2021-08-26 stsp option is particularly discouraged if changes being sent are based
1500 f8a36e22 2021-08-26 stsp on an out-of-date copy of a branch in the remote repository.
1501 f8a36e22 2021-08-26 stsp Instead of using the
1502 f8a36e22 2021-08-26 stsp .Fl f
1503 f8a36e22 2021-08-26 stsp option, new changes should
1504 f8a36e22 2021-08-26 stsp be fetched with
1505 f8a36e22 2021-08-26 stsp .Cm got fetch
1506 f8a36e22 2021-08-26 stsp and local branches should be rebased with
1507 f8a36e22 2021-08-26 stsp .Cm got rebase ,
1508 f8a36e22 2021-08-26 stsp followed by another attempt to send the changes.
1509 f8a36e22 2021-08-26 stsp .Pp
1510 f8a36e22 2021-08-26 stsp The
1511 f8a36e22 2021-08-26 stsp .Fl f
1512 f8a36e22 2021-08-26 stsp option should only be needed in situations where the remote repository's
1513 f8a36e22 2021-08-26 stsp copy of a branch or tag is known to be out-of-date and is considered
1514 f8a36e22 2021-08-26 stsp disposable.
1515 f8a36e22 2021-08-26 stsp The risks of creating inconsistencies between different repositories
1516 f8a36e22 2021-08-26 stsp should also be taken into account.
1517 f8a36e22 2021-08-26 stsp .It Fl r Ar repository-path
1518 f8a36e22 2021-08-26 stsp Use the repository at the specified path.
1519 f8a36e22 2021-08-26 stsp If not specified, assume the repository is located at or above the current
1520 f8a36e22 2021-08-26 stsp working directory.
1521 f8a36e22 2021-08-26 stsp If this directory is a
1522 f8a36e22 2021-08-26 stsp .Nm
1523 f8a36e22 2021-08-26 stsp work tree, use the repository path associated with this work tree.
1524 f8a36e22 2021-08-26 stsp .It Fl t Ar tag
1525 f8a36e22 2021-08-26 stsp Send the specified
1526 f8a36e22 2021-08-26 stsp .Ar tag
1527 f8a36e22 2021-08-26 stsp from the local repository's
1528 f8a36e22 2021-08-26 stsp .Dq refs/tags/
1529 f8a36e22 2021-08-26 stsp reference namespace, in addition to any branches that are being sent.
1530 f8a36e22 2021-08-26 stsp The
1531 f8a36e22 2021-08-26 stsp .Fl t
1532 f8a36e22 2021-08-26 stsp option may be specified multiple times to build a list of tags to send.
1533 f8a36e22 2021-08-26 stsp No tags will be sent if the
1534 f8a36e22 2021-08-26 stsp .Fl t
1535 f8a36e22 2021-08-26 stsp option is not used.
1536 f8a36e22 2021-08-26 stsp .Pp
1537 f8a36e22 2021-08-26 stsp Raise an error if the specified
1538 f8a36e22 2021-08-26 stsp .Ar tag
1539 f8a36e22 2021-08-26 stsp already exists in the remote repository, unless the
1540 f8a36e22 2021-08-26 stsp .Fl f
1541 93a300b2 2021-08-26 stsp option is used to overwrite the server's copy of the tag.
1542 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1543 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1544 f8a36e22 2021-08-26 stsp .Pp
1545 f8a36e22 2021-08-26 stsp Cannot be used together with the
1546 f8a36e22 2021-08-26 stsp .Fl T
1547 f8a36e22 2021-08-26 stsp option.
1548 f8a36e22 2021-08-26 stsp .It Fl T
1549 f8a36e22 2021-08-26 stsp Attempt to send all tags from the local repository's
1550 f8a36e22 2021-08-26 stsp .Dq refs/tags/
1551 f8a36e22 2021-08-26 stsp reference namespace.
1552 f8a36e22 2021-08-26 stsp The
1553 f8a36e22 2021-08-26 stsp .Fl T
1554 f8a36e22 2021-08-26 stsp option is equivalent to listing all tags with multiple
1555 f8a36e22 2021-08-26 stsp .Fl t
1556 f8a36e22 2021-08-26 stsp options.
1557 f8a36e22 2021-08-26 stsp Cannot be used together with the
1558 f8a36e22 2021-08-26 stsp .Fl t
1559 f8a36e22 2021-08-26 stsp option.
1560 f8a36e22 2021-08-26 stsp .It Fl q
1561 f8a36e22 2021-08-26 stsp Suppress progress reporting output.
1562 f8a36e22 2021-08-26 stsp The same option will be passed to
1563 f8a36e22 2021-08-26 stsp .Xr ssh 1
1564 f8a36e22 2021-08-26 stsp if applicable.
1565 f8a36e22 2021-08-26 stsp .It Fl v
1566 f8a36e22 2021-08-26 stsp Verbose mode.
1567 f8a36e22 2021-08-26 stsp Causes
1568 f8a36e22 2021-08-26 stsp .Cm got send
1569 f8a36e22 2021-08-26 stsp to print debugging messages to standard error output.
1570 f8a36e22 2021-08-26 stsp The same option will be passed to
1571 f8a36e22 2021-08-26 stsp .Xr ssh 1
1572 f8a36e22 2021-08-26 stsp if applicable.
1573 f8a36e22 2021-08-26 stsp Multiple -v options increase the verbosity.
1574 f8a36e22 2021-08-26 stsp The maximum is 3.
1575 f8a36e22 2021-08-26 stsp .El
1576 f8a36e22 2021-08-26 stsp .It Cm se
1577 f8a36e22 2021-08-26 stsp Short alias for
1578 f8a36e22 2021-08-26 stsp .Cm send .
1579 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1580 234035bc 2019-06-01 stsp Merge changes from a single
1581 234035bc 2019-06-01 stsp .Ar commit
1582 234035bc 2019-06-01 stsp into the work tree.
1583 234035bc 2019-06-01 stsp The specified
1584 234035bc 2019-06-01 stsp .Ar commit
1585 a16d97bd 2021-09-02 stsp should be on a different branch than the work tree's base commit.
1586 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1587 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1588 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1589 234035bc 2019-06-01 stsp .Pp
1590 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1591 234035bc 2019-06-01 stsp .Bl -column YXZ description
1592 234035bc 2019-06-01 stsp .It G Ta file was merged
1593 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1594 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1595 234035bc 2019-06-01 stsp .It D Ta file was deleted
1596 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1597 234035bc 2019-06-01 stsp .It A Ta new file was added
1598 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1599 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1600 74416c47 2019-05-09 stsp .El
1601 234035bc 2019-06-01 stsp .Pp
1602 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1603 234035bc 2019-06-01 stsp may be viewed with
1604 234035bc 2019-06-01 stsp .Cm got diff ,
1605 234035bc 2019-06-01 stsp amended manually or with further
1606 234035bc 2019-06-01 stsp .Cm got cherrypick
1607 bc3056e3 2019-08-18 stsp commands,
1608 234035bc 2019-06-01 stsp committed with
1609 234035bc 2019-06-01 stsp .Cm got commit ,
1610 234035bc 2019-06-01 stsp or discarded again with
1611 234035bc 2019-06-01 stsp .Cm got revert .
1612 234035bc 2019-06-01 stsp .Pp
1613 234035bc 2019-06-01 stsp .Cm got cherrypick
1614 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1615 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1616 234035bc 2019-06-01 stsp to a single base commit with
1617 234035bc 2019-06-01 stsp .Cm got update .
1618 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1619 234035bc 2019-06-01 stsp conflicts must be resolved first.
1620 016477fd 2019-07-09 stsp .It Cm cy
1621 97b3a7be 2019-07-09 stsp Short alias for
1622 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1623 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1624 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1625 5ef14e63 2019-06-02 stsp .Ar commit
1626 5ef14e63 2019-06-02 stsp into the work tree.
1627 5ef14e63 2019-06-02 stsp The specified
1628 5ef14e63 2019-06-02 stsp .Ar commit
1629 a16d97bd 2021-09-02 stsp should be on the same branch as the work tree's base commit.
1630 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1631 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1632 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1633 5ef14e63 2019-06-02 stsp .Pp
1634 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1635 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1636 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1637 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1638 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1639 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1640 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1641 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1642 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1643 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1644 234035bc 2019-06-01 stsp .El
1645 5ef14e63 2019-06-02 stsp .Pp
1646 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1647 5ef14e63 2019-06-02 stsp which may be viewed with
1648 5ef14e63 2019-06-02 stsp .Cm got diff ,
1649 5ef14e63 2019-06-02 stsp amended manually or with further
1650 778a73c2 2019-07-12 stsp .Cm got backout
1651 bc3056e3 2019-08-18 stsp commands,
1652 5ef14e63 2019-06-02 stsp committed with
1653 5ef14e63 2019-06-02 stsp .Cm got commit ,
1654 5ef14e63 2019-06-02 stsp or discarded again with
1655 5ef14e63 2019-06-02 stsp .Cm got revert .
1656 5ef14e63 2019-06-02 stsp .Pp
1657 92228c38 2019-06-02 stsp .Cm got backout
1658 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1659 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1660 92228c38 2019-06-02 stsp to a single base commit with
1661 92228c38 2019-06-02 stsp .Cm got update .
1662 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1663 92228c38 2019-06-02 stsp conflicts must be resolved first.
1664 97b3a7be 2019-07-09 stsp .It Cm bo
1665 97b3a7be 2019-07-09 stsp Short alias for
1666 97b3a7be 2019-07-09 stsp .Cm backout .
1667 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
1668 818c7501 2019-07-11 stsp Rebase commits on the specified
1669 818c7501 2019-07-11 stsp .Ar branch
1670 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1671 818c7501 2019-07-11 stsp The
1672 818c7501 2019-07-11 stsp .Ar branch
1673 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1674 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1675 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1676 818c7501 2019-07-11 stsp .Ar branch
1677 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1678 f09e2405 2019-07-11 stsp of the specified
1679 818c7501 2019-07-11 stsp .Ar branch
1680 f09e2405 2019-07-11 stsp has been rebased.
1681 818c7501 2019-07-11 stsp .Pp
1682 2b6826ba 2020-02-24 stsp When
1683 2b6826ba 2020-02-24 stsp .Cm got rebase
1684 2b6826ba 2020-02-24 stsp is used as intended, the specified
1685 2b6826ba 2020-02-24 stsp .Ar branch
1686 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1687 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1688 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1689 2b6826ba 2020-02-24 stsp .Cm got update -b
1690 2b6826ba 2020-02-24 stsp before starting the
1691 2b6826ba 2020-02-24 stsp .Cm rebase
1692 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1693 2b6826ba 2020-02-24 stsp a common history with the specified
1694 2b6826ba 2020-02-24 stsp .Ar branch
1695 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1696 c10890ce 2020-02-25 stsp remote repository.
1697 2b6826ba 2020-02-24 stsp .Pp
1698 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1699 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1700 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1701 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1702 818c7501 2019-07-11 stsp .Ar branch ,
1703 818c7501 2019-07-11 stsp but with different commit IDs.
1704 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1705 f09e2405 2019-07-11 stsp the new version of the specified
1706 818c7501 2019-07-11 stsp .Ar branch
1707 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1708 e600f124 2021-03-21 stsp .Pp
1709 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
1710 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
1711 e600f124 2021-03-21 stsp reference namespace.
1712 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
1713 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
1714 e600f124 2021-03-21 stsp .Cm got rebase -l
1715 e600f124 2021-03-21 stsp command.
1716 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
1717 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
1718 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1719 818c7501 2019-07-11 stsp .Pp
1720 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1721 818c7501 2019-07-11 stsp using the following status codes:
1722 818c7501 2019-07-11 stsp .Bl -column YXZ description
1723 818c7501 2019-07-11 stsp .It G Ta file was merged
1724 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1725 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1726 818c7501 2019-07-11 stsp .It D Ta file was deleted
1727 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1728 818c7501 2019-07-11 stsp .It A Ta new file was added
1729 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1730 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1731 5ef14e63 2019-06-02 stsp .El
1732 818c7501 2019-07-11 stsp .Pp
1733 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1734 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1735 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1736 818c7501 2019-07-11 stsp .Ar branch
1737 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1738 818c7501 2019-07-11 stsp .Pp
1739 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1740 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1741 f09e2405 2019-07-11 stsp when the rebase operation continues.
1742 ff0d2220 2019-07-11 stsp .Pp
1743 818c7501 2019-07-11 stsp .Cm got rebase
1744 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1745 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1746 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1747 818c7501 2019-07-11 stsp .Cm got update .
1748 4ed9f614 2019-08-04 stsp If changes have been staged with
1749 4ed9f614 2019-08-04 stsp .Cm got stage ,
1750 bc3056e3 2019-08-18 stsp these changes must first be committed with
1751 4ed9f614 2019-08-04 stsp .Cm got commit
1752 4ed9f614 2019-08-04 stsp or unstaged with
1753 4ed9f614 2019-08-04 stsp .Cm got unstage .
1754 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1755 f09e2405 2019-07-11 stsp committed with
1756 f09e2405 2019-07-11 stsp .Cm got commit
1757 f09e2405 2019-07-11 stsp or reverted with
1758 f09e2405 2019-07-11 stsp .Cm got revert .
1759 64c6d990 2019-07-11 stsp If the
1760 64c6d990 2019-07-11 stsp .Ar branch
1761 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1762 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1763 818c7501 2019-07-11 stsp .Pp
1764 7d5807f4 2019-07-11 stsp The
1765 7d5807f4 2019-07-11 stsp .Cm got update
1766 7d5807f4 2019-07-11 stsp and
1767 7d5807f4 2019-07-11 stsp .Cm got commit
1768 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1769 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1770 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1771 818c7501 2019-07-11 stsp .Pp
1772 818c7501 2019-07-11 stsp The options for
1773 818c7501 2019-07-11 stsp .Cm got rebase
1774 818c7501 2019-07-11 stsp are as follows:
1775 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1776 818c7501 2019-07-11 stsp .It Fl a
1777 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1778 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1779 818c7501 2019-07-11 stsp .It Fl c
1780 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1781 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1782 e600f124 2021-03-21 stsp .It Fl l
1783 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
1784 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
1785 e600f124 2021-03-21 stsp reference namespace.
1786 e600f124 2021-03-21 stsp .Pp
1787 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
1788 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
1789 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
1790 e600f124 2021-03-21 stsp Given these object IDs,
1791 e600f124 2021-03-21 stsp the
1792 e600f124 2021-03-21 stsp .Cm got log
1793 e600f124 2021-03-21 stsp command with the
1794 e600f124 2021-03-21 stsp .Fl c
1795 e600f124 2021-03-21 stsp and
1796 e600f124 2021-03-21 stsp .Fl x
1797 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
1798 e600f124 2021-03-21 stsp and the
1799 e600f124 2021-03-21 stsp .Cm got branch
1800 e600f124 2021-03-21 stsp command with the
1801 e600f124 2021-03-21 stsp .Fl c
1802 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
1803 e600f124 2021-03-21 stsp .Pp
1804 e600f124 2021-03-21 stsp If a
1805 e600f124 2021-03-21 stsp .Ar branch
1806 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
1807 e600f124 2021-03-21 stsp branch.
1808 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
1809 e600f124 2021-03-21 stsp .Pp
1810 e600f124 2021-03-21 stsp If this option is used,
1811 e600f124 2021-03-21 stsp .Cm got rebase
1812 e600f124 2021-03-21 stsp does not require a work tree.
1813 e600f124 2021-03-21 stsp None of the other options can be used together with
1814 e600f124 2021-03-21 stsp .Fl l .
1815 643b85bc 2021-07-16 stsp .It Fl X
1816 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
1817 643b85bc 2021-07-16 stsp in the
1818 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
1819 643b85bc 2021-07-16 stsp reference namespace.
1820 643b85bc 2021-07-16 stsp .Pp
1821 643b85bc 2021-07-16 stsp If a
1822 643b85bc 2021-07-16 stsp .Ar branch
1823 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
1824 643b85bc 2021-07-16 stsp this branch.
1825 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
1826 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
1827 643b85bc 2021-07-16 stsp .Pp
1828 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
1829 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
1830 643b85bc 2021-07-16 stsp Git's garbage collector or
1831 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
1832 643b85bc 2021-07-16 stsp .Pp
1833 643b85bc 2021-07-16 stsp If this option is used,
1834 643b85bc 2021-07-16 stsp .Cm got rebase
1835 643b85bc 2021-07-16 stsp does not require a work tree.
1836 643b85bc 2021-07-16 stsp None of the other options can be used together with
1837 643b85bc 2021-07-16 stsp .Fl X .
1838 818c7501 2019-07-11 stsp .El
1839 818c7501 2019-07-11 stsp .It Cm rb
1840 818c7501 2019-07-11 stsp Short alias for
1841 818c7501 2019-07-11 stsp .Cm rebase .
1842 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
1843 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1844 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1845 6e54d307 2020-02-24 stsp .Pp
1846 6e54d307 2020-02-24 stsp Before starting a
1847 6e54d307 2020-02-24 stsp .Cm histedit
1848 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1849 6e54d307 2020-02-24 stsp .Cm got update -b
1850 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1851 6e54d307 2020-02-24 stsp current branch of the work tree.
1852 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1853 6e54d307 2020-02-24 stsp touched by the
1854 6e54d307 2020-02-24 stsp .Cm histedit
1855 6e54d307 2020-02-24 stsp operation.
1856 0ebf8283 2019-07-24 stsp .Pp
1857 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1858 6e54d307 2020-02-24 stsp must be set with
1859 6e54d307 2020-02-24 stsp .Cm got update -c
1860 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1861 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1862 6e54d307 2020-02-24 stsp by the
1863 6e54d307 2020-02-24 stsp .Cm histedit
1864 6e54d307 2020-02-24 stsp operation.
1865 6e54d307 2020-02-24 stsp .Pp
1866 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1867 0ebf8283 2019-07-24 stsp .Ar histedit script
1868 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1869 46fa4c83 2020-02-24 stsp command line, or generated with the
1870 466785b9 2020-12-10 jrick .Fl f
1871 466785b9 2020-12-10 jrick or
1872 083957f4 2020-02-24 stsp .Fl m
1873 466785b9 2020-12-10 jrick options.
1874 083957f4 2020-02-24 stsp .Pp
1875 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1876 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1877 0ebf8283 2019-07-24 stsp whitespace and an argument.
1878 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1879 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1880 0ebf8283 2019-07-24 stsp Lines which begin with the
1881 0ebf8283 2019-07-24 stsp .Sq #
1882 0ebf8283 2019-07-24 stsp character are ignored entirely.
1883 0ebf8283 2019-07-24 stsp .Pp
1884 0ebf8283 2019-07-24 stsp The available commands are as follows:
1885 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1886 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1887 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1888 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1889 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1890 0ebf8283 2019-07-24 stsp listed further below that will be used.
1891 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1892 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1893 0ebf8283 2019-07-24 stsp the commit on the previous line.
1894 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1895 0ebf8283 2019-07-24 stsp log message can be written.
1896 0ebf8283 2019-07-24 stsp .El
1897 0ebf8283 2019-07-24 stsp .Pp
1898 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1899 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1900 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1901 0ebf8283 2019-07-24 stsp .Pp
1902 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1903 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1904 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1905 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1906 498a90b7 2019-07-25 stsp switched to it.
1907 0ebf8283 2019-07-24 stsp .Pp
1908 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
1909 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
1910 e600f124 2021-03-21 stsp reference namespace.
1911 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
1912 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
1913 e600f124 2021-03-21 stsp .Cm got histedit -l
1914 e600f124 2021-03-21 stsp command.
1915 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
1916 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
1917 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1918 e600f124 2021-03-21 stsp .Pp
1919 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1920 0ebf8283 2019-07-24 stsp using the following status codes:
1921 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1922 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1923 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1924 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1925 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1926 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1927 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1928 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1929 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1930 0ebf8283 2019-07-24 stsp .El
1931 0ebf8283 2019-07-24 stsp .Pp
1932 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1933 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1934 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1935 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1936 0ebf8283 2019-07-24 stsp .Pp
1937 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1938 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1939 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1940 0ebf8283 2019-07-24 stsp .Pp
1941 0ebf8283 2019-07-24 stsp .Cm got histedit
1942 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1943 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1944 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1945 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1946 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1947 0ebf8283 2019-07-24 stsp to a single base commit with
1948 0ebf8283 2019-07-24 stsp .Cm got update .
1949 4ed9f614 2019-08-04 stsp If changes have been staged with
1950 4ed9f614 2019-08-04 stsp .Cm got stage ,
1951 bc3056e3 2019-08-18 stsp these changes must first be committed with
1952 4ed9f614 2019-08-04 stsp .Cm got commit
1953 4ed9f614 2019-08-04 stsp or unstaged with
1954 4ed9f614 2019-08-04 stsp .Cm got unstage .
1955 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1956 0ebf8283 2019-07-24 stsp committed with
1957 0ebf8283 2019-07-24 stsp .Cm got commit
1958 0ebf8283 2019-07-24 stsp or reverted with
1959 0ebf8283 2019-07-24 stsp .Cm got revert .
1960 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1961 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1962 0ebf8283 2019-07-24 stsp .Pp
1963 0ebf8283 2019-07-24 stsp The
1964 7ef62c4e 2020-02-24 stsp .Cm got update ,
1965 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1966 65db4ffb 2020-02-24 stsp and
1967 65db4ffb 2020-02-24 stsp .Cm got integrate
1968 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1969 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1970 0ebf8283 2019-07-24 stsp .Cm got commit
1971 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1972 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1973 0ebf8283 2019-07-24 stsp .Pp
1974 0ebf8283 2019-07-24 stsp The options for
1975 0ebf8283 2019-07-24 stsp .Cm got histedit
1976 0ebf8283 2019-07-24 stsp are as follows:
1977 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1978 0ebf8283 2019-07-24 stsp .It Fl a
1979 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1980 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1981 0ebf8283 2019-07-24 stsp .It Fl c
1982 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1983 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1984 466785b9 2020-12-10 jrick .It Fl f
1985 466785b9 2020-12-10 jrick Fold all commits into a single commit.
1986 466785b9 2020-12-10 jrick This option is a quick equivalent to a histedit script which folds all
1987 466785b9 2020-12-10 jrick commits, combining them all into one commit.
1988 2a78779e 2020-12-11 stsp The
1989 2a78779e 2020-12-11 stsp .Fl f
1990 2a78779e 2020-12-11 stsp option can only be used when starting a new histedit operation.
1991 466785b9 2020-12-10 jrick If this option is used, no other command-line arguments are allowed.
1992 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1993 ddbfac99 2020-02-24 stsp Use the specified
1994 ddbfac99 2020-02-24 stsp .Ar histedit-script
1995 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1996 ddbfac99 2020-02-24 stsp can be written.
1997 083957f4 2020-02-24 stsp .It Fl m
1998 083957f4 2020-02-24 stsp Edit log messages only.
1999 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
2000 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
2001 083957f4 2020-02-24 stsp The
2002 083957f4 2020-02-24 stsp .Fl m
2003 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
2004 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
2005 e600f124 2021-03-21 stsp .It Fl l
2006 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
2007 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
2008 e600f124 2021-03-21 stsp reference namespace.
2009 e600f124 2021-03-21 stsp .Pp
2010 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2011 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
2012 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2013 e600f124 2021-03-21 stsp Given these object IDs,
2014 e600f124 2021-03-21 stsp the
2015 e600f124 2021-03-21 stsp .Cm got log
2016 e600f124 2021-03-21 stsp command with the
2017 e600f124 2021-03-21 stsp .Fl c
2018 e600f124 2021-03-21 stsp and
2019 e600f124 2021-03-21 stsp .Fl x
2020 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2021 e600f124 2021-03-21 stsp and the
2022 e600f124 2021-03-21 stsp .Cm got branch
2023 e600f124 2021-03-21 stsp command with the
2024 e600f124 2021-03-21 stsp .Fl c
2025 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
2026 e600f124 2021-03-21 stsp .Pp
2027 e600f124 2021-03-21 stsp If a
2028 e600f124 2021-03-21 stsp .Ar branch
2029 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2030 e600f124 2021-03-21 stsp branch.
2031 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2032 e600f124 2021-03-21 stsp .Pp
2033 e600f124 2021-03-21 stsp If this option is used,
2034 e600f124 2021-03-21 stsp .Cm got histedit
2035 e600f124 2021-03-21 stsp does not require a work tree.
2036 e600f124 2021-03-21 stsp None of the other options can be used together with
2037 e600f124 2021-03-21 stsp .Fl l .
2038 643b85bc 2021-07-16 stsp .It Fl X
2039 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
2040 643b85bc 2021-07-16 stsp in the
2041 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
2042 643b85bc 2021-07-16 stsp reference namespace.
2043 643b85bc 2021-07-16 stsp .Pp
2044 643b85bc 2021-07-16 stsp If a
2045 643b85bc 2021-07-16 stsp .Ar branch
2046 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2047 643b85bc 2021-07-16 stsp this branch.
2048 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2049 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
2050 643b85bc 2021-07-16 stsp .Pp
2051 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2052 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2053 643b85bc 2021-07-16 stsp Git's garbage collector or
2054 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2055 643b85bc 2021-07-16 stsp .Pp
2056 643b85bc 2021-07-16 stsp If this option is used,
2057 643b85bc 2021-07-16 stsp .Cm got histedit
2058 643b85bc 2021-07-16 stsp does not require a work tree.
2059 643b85bc 2021-07-16 stsp None of the other options can be used together with
2060 643b85bc 2021-07-16 stsp .Fl X .
2061 818c7501 2019-07-11 stsp .El
2062 0ebf8283 2019-07-24 stsp .It Cm he
2063 0ebf8283 2019-07-24 stsp Short alias for
2064 0ebf8283 2019-07-24 stsp .Cm histedit .
2065 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
2066 2822a352 2019-10-15 stsp Integrate the specified
2067 2822a352 2019-10-15 stsp .Ar branch
2068 2822a352 2019-10-15 stsp into the work tree's current branch.
2069 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
2070 2822a352 2019-10-15 stsp .Ar branch ,
2071 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
2072 2822a352 2019-10-15 stsp head commit of the integrated
2073 2822a352 2019-10-15 stsp .Ar branch .
2074 2822a352 2019-10-15 stsp .Pp
2075 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
2076 2822a352 2019-10-15 stsp will be pointing at the same commit.
2077 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
2078 2822a352 2019-10-15 stsp In case the integrated
2079 2822a352 2019-10-15 stsp .Ar branch
2080 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
2081 2822a352 2019-10-15 stsp .Cm got branch -d .
2082 2822a352 2019-10-15 stsp .Pp
2083 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
2084 2822a352 2019-10-15 stsp .Bl -column YXZ description
2085 2822a352 2019-10-15 stsp .It U Ta file was updated
2086 2822a352 2019-10-15 stsp .It D Ta file was deleted
2087 2822a352 2019-10-15 stsp .It A Ta new file was added
2088 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
2089 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
2090 2822a352 2019-10-15 stsp .El
2091 2822a352 2019-10-15 stsp .Pp
2092 2822a352 2019-10-15 stsp .Cm got integrate
2093 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
2094 2822a352 2019-10-15 stsp Most importantly, the
2095 2822a352 2019-10-15 stsp .Ar branch
2096 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
2097 2822a352 2019-10-15 stsp .Cm got rebase
2098 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
2099 2822a352 2019-10-15 stsp resolve merge conflicts.
2100 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
2101 2822a352 2019-10-15 stsp to a single base commit with
2102 2822a352 2019-10-15 stsp .Cm got update .
2103 2822a352 2019-10-15 stsp If changes have been staged with
2104 2822a352 2019-10-15 stsp .Cm got stage ,
2105 2822a352 2019-10-15 stsp these changes must first be committed with
2106 2822a352 2019-10-15 stsp .Cm got commit
2107 2822a352 2019-10-15 stsp or unstaged with
2108 2822a352 2019-10-15 stsp .Cm got unstage .
2109 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
2110 2822a352 2019-10-15 stsp committed with
2111 2822a352 2019-10-15 stsp .Cm got commit
2112 2822a352 2019-10-15 stsp or reverted with
2113 2822a352 2019-10-15 stsp .Cm got revert .
2114 2822a352 2019-10-15 stsp .It Cm ig
2115 2822a352 2019-10-15 stsp Short alias for
2116 2822a352 2019-10-15 stsp .Cm integrate .
2117 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 ...
2118 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
2119 2db2652d 2019-08-07 stsp If no
2120 2db2652d 2019-08-07 stsp .Ar path
2121 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
2122 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
2123 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
2124 4ed9f614 2019-08-04 stsp .Cm got status .
2125 4ed9f614 2019-08-04 stsp .Pp
2126 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2127 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
2128 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
2129 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
2130 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
2131 9d8b19a4 2019-08-04 stsp .El
2132 9d8b19a4 2019-08-04 stsp .Pp
2133 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
2134 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
2135 9d8b19a4 2019-08-04 stsp committed.
2136 9d8b19a4 2019-08-04 stsp .Pp
2137 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
2138 4ed9f614 2019-08-04 stsp .Cm got commit ,
2139 4ed9f614 2019-08-04 stsp .Cm got status ,
2140 4ed9f614 2019-08-04 stsp and
2141 4ed9f614 2019-08-04 stsp .Cm got diff .
2142 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
2143 4ed9f614 2019-08-04 stsp .Cm got commit
2144 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
2145 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
2146 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
2147 4ed9f614 2019-08-04 stsp The
2148 4ed9f614 2019-08-04 stsp .Cm got status
2149 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
2150 4ed9f614 2019-08-04 stsp The
2151 4ed9f614 2019-08-04 stsp .Cm got diff
2152 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
2153 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
2154 4ed9f614 2019-08-04 stsp The
2155 4ed9f614 2019-08-04 stsp .Cm got revert
2156 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
2157 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
2158 4ed9f614 2019-08-04 stsp .Pp
2159 4ed9f614 2019-08-04 stsp The options for
2160 4ed9f614 2019-08-04 stsp .Cm got stage
2161 4ed9f614 2019-08-04 stsp are as follows:
2162 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
2163 4ed9f614 2019-08-04 stsp .It Fl l
2164 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
2165 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
2166 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
2167 1dd86744 2019-08-12 anthony among the specified paths.
2168 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
2169 dc424a06 2019-08-07 stsp .It Fl p
2170 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
2171 dc424a06 2019-08-07 stsp select or reject changes for staging based on
2172 dc424a06 2019-08-07 stsp .Dq y
2173 6d23ec10 2019-08-08 stsp (stage change),
2174 dc424a06 2019-08-07 stsp .Dq n
2175 6d23ec10 2019-08-08 stsp (reject change), and
2176 b353a198 2019-08-07 stsp .Dq q
2177 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
2178 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
2179 dc424a06 2019-08-07 stsp modified file content can be staged.
2180 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
2181 6d23ec10 2019-08-08 stsp their entirety.
2182 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
2183 dc424a06 2019-08-07 stsp With the
2184 dc424a06 2019-08-07 stsp .Fl p
2185 3a070a2b 2019-08-07 stsp option, read
2186 3a070a2b 2019-08-07 stsp .Dq y ,
2187 3a070a2b 2019-08-07 stsp .Dq n ,
2188 3a070a2b 2019-08-07 stsp and
2189 3a070a2b 2019-08-07 stsp .Dq q
2190 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
2191 0e2f5884 2019-08-07 stsp .Ar response-script
2192 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
2193 35213c7c 2020-07-23 stsp .It Fl S
2194 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
2195 af358f55 2020-07-23 stsp that is under version control.
2196 af358f55 2020-07-23 stsp By default,
2197 af358f55 2020-07-23 stsp .Cm got stage
2198 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
2199 35213c7c 2020-07-23 stsp As a precaution,
2200 35213c7c 2020-07-23 stsp .Nm
2201 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
2202 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
2203 af358f55 2020-07-23 stsp points outside of the work tree.
2204 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
2205 af358f55 2020-07-23 stsp .Dq make obj
2206 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
2207 af358f55 2020-07-23 stsp version control.
2208 4ed9f614 2019-08-04 stsp .El
2209 4ed9f614 2019-08-04 stsp .Pp
2210 4ed9f614 2019-08-04 stsp .Cm got stage
2211 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
2212 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
2213 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
2214 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
2215 4ed9f614 2019-08-04 stsp .Cm got update
2216 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
2217 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
2218 4ed9f614 2019-08-04 stsp .Pp
2219 4ed9f614 2019-08-04 stsp The
2220 4ed9f614 2019-08-04 stsp .Cm got update ,
2221 4ed9f614 2019-08-04 stsp .Cm got rebase ,
2222 4ed9f614 2019-08-04 stsp and
2223 4ed9f614 2019-08-04 stsp .Cm got histedit
2224 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
2225 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
2226 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
2227 4ed9f614 2019-08-04 stsp .Cm got unstage
2228 4ed9f614 2019-08-04 stsp before it can be updated with
2229 4ed9f614 2019-08-04 stsp .Cm got update ,
2230 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
2231 4ed9f614 2019-08-04 stsp .It Cm sg
2232 4ed9f614 2019-08-04 stsp Short alias for
2233 4ed9f614 2019-08-04 stsp .Cm stage .
2234 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2235 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
2236 4ed9f614 2019-08-04 stsp back into non-staged status.
2237 4ed9f614 2019-08-04 stsp If no
2238 4ed9f614 2019-08-04 stsp .Ar path
2239 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
2240 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
2241 4ed9f614 2019-08-04 stsp .Pp
2242 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2243 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
2244 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
2245 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
2246 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
2247 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
2248 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
2249 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2250 4ed9f614 2019-08-04 stsp .El
2251 2e1f37b0 2019-08-08 stsp .Pp
2252 2e1f37b0 2019-08-08 stsp The options for
2253 2e1f37b0 2019-08-08 stsp .Cm got unstage
2254 2e1f37b0 2019-08-08 stsp are as follows:
2255 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
2256 2e1f37b0 2019-08-08 stsp .It Fl p
2257 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
2258 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
2259 2e1f37b0 2019-08-08 stsp .Dq y
2260 2e1f37b0 2019-08-08 stsp (unstage change),
2261 2e1f37b0 2019-08-08 stsp .Dq n
2262 2e1f37b0 2019-08-08 stsp (keep change staged), and
2263 2e1f37b0 2019-08-08 stsp .Dq q
2264 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
2265 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
2266 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
2267 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
2268 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
2269 2e1f37b0 2019-08-08 stsp With the
2270 2e1f37b0 2019-08-08 stsp .Fl p
2271 2e1f37b0 2019-08-08 stsp option, read
2272 2e1f37b0 2019-08-08 stsp .Dq y ,
2273 2e1f37b0 2019-08-08 stsp .Dq n ,
2274 2e1f37b0 2019-08-08 stsp and
2275 2e1f37b0 2019-08-08 stsp .Dq q
2276 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
2277 2e1f37b0 2019-08-08 stsp .Ar response-script
2278 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
2279 2e1f37b0 2019-08-08 stsp .El
2280 4ed9f614 2019-08-04 stsp .It Cm ug
2281 4ed9f614 2019-08-04 stsp Short alias for
2282 4ed9f614 2019-08-04 stsp .Cm unstage .
2283 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 ...
2284 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
2285 896e9b6f 2019-08-26 stsp text format.
2286 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
2287 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
2288 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
2289 896e9b6f 2019-08-26 stsp .Pp
2290 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
2291 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
2292 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
2293 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
2294 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2295 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
2296 01073a5d 2019-08-22 stsp .Pp
2297 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
2298 896e9b6f 2019-08-26 stsp .Fl P
2299 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
2300 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
2301 896e9b6f 2019-08-26 stsp .Pp
2302 01073a5d 2019-08-22 stsp The options for
2303 01073a5d 2019-08-22 stsp .Cm got cat
2304 01073a5d 2019-08-22 stsp are as follows:
2305 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
2306 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
2307 896e9b6f 2019-08-26 stsp Look up paths in the specified
2308 896e9b6f 2019-08-26 stsp .Ar commit .
2309 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
2310 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
2311 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
2312 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
2313 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2314 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
2315 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
2316 01073a5d 2019-08-22 stsp Use the repository at the specified path.
2317 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
2318 01073a5d 2019-08-22 stsp working directory.
2319 01073a5d 2019-08-22 stsp If this directory is a
2320 01073a5d 2019-08-22 stsp .Nm
2321 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
2322 896e9b6f 2019-08-26 stsp .It Fl P
2323 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
2324 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
2325 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
2326 4ed9f614 2019-08-04 stsp .El
2327 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
2328 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
2329 b2118c49 2020-07-28 stsp See
2330 b2118c49 2020-07-28 stsp .Xr got-worktree 5
2331 b2118c49 2020-07-28 stsp for details.
2332 b2118c49 2020-07-28 stsp .Pp
2333 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
2334 b2118c49 2020-07-28 stsp current working directory.
2335 b2118c49 2020-07-28 stsp .Pp
2336 b2118c49 2020-07-28 stsp If one or more
2337 b2118c49 2020-07-28 stsp .Ar path
2338 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
2339 b2118c49 2020-07-28 stsp files located at or within these paths.
2340 b2118c49 2020-07-28 stsp If a
2341 b2118c49 2020-07-28 stsp .Ar path
2342 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
2343 b2118c49 2020-07-28 stsp for all tracked files.
2344 01073a5d 2019-08-22 stsp .El
2345 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
2346 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
2347 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
2348 74416c47 2019-05-09 stsp The author's name and email address for
2349 21a44f98 2019-07-15 stsp .Cm got commit
2350 21a44f98 2019-07-15 stsp and
2351 21a44f98 2019-07-15 stsp .Cm got import ,
2352 74416c47 2019-05-09 stsp for example:
2353 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2354 84792843 2019-08-09 stsp Because
2355 0e444aba 2019-08-08 stsp .Xr git 1
2356 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
2357 0e444aba 2019-08-08 stsp .Nm
2358 84792843 2019-08-09 stsp attempts to reject
2359 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
2360 84792843 2019-08-09 stsp environment variables with a missing email address.
2361 c9956ddf 2019-09-08 stsp .Pp
2362 93a300b2 2021-08-26 stsp .Ev GOT_AUTHOR will be overridden by configuration settings in
2363 50b0790e 2020-09-11 stsp .Xr got.conf 5
2364 50b0790e 2020-09-11 stsp or by Git's
2365 aba9c984 2019-09-08 stsp .Dv user.name
2366 aba9c984 2019-09-08 stsp and
2367 709ae9eb 2019-09-08 stsp .Dv user.email
2368 709ae9eb 2019-09-08 stsp configuration settings in the repository's
2369 aba9c984 2019-09-08 stsp .Pa .git/config
2370 50b0790e 2020-09-11 stsp file.
2371 257add31 2020-09-09 stsp The
2372 c9956ddf 2019-09-08 stsp .Dv user.name
2373 c9956ddf 2019-09-08 stsp and
2374 c9956ddf 2019-09-08 stsp .Dv user.email
2375 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
2376 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
2377 257add31 2020-09-09 stsp configuration file will only be used if neither
2378 257add31 2020-09-09 stsp .Xr got.conf 5
2379 257add31 2020-09-09 stsp nor the
2380 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
2381 257add31 2020-09-09 stsp environment variable provide author information.
2382 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
2383 23594da9 2019-05-13 stsp The editor spawned by
2384 8e7bd50a 2019-08-22 stsp .Cm got commit ,
2385 46215d2a 2020-09-11 stsp .Cm got histedit ,
2386 8e7bd50a 2019-08-22 stsp .Cm got import ,
2387 8e7bd50a 2019-08-22 stsp or
2388 8e7bd50a 2019-08-22 stsp .Cm got tag .
2389 5b735925 2020-09-15 stsp If not set, the
2390 5b735925 2020-09-15 stsp .Xr ed 1
2391 5b735925 2020-09-15 stsp text editor will be spawned in order to give
2392 5b735925 2020-09-15 stsp .Xr ed 1
2393 5b735925 2020-09-15 stsp the attention it deserves.
2394 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
2395 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
2396 b1ebc001 2019-08-13 stsp .Cm got log .
2397 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
2398 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
2399 74416c47 2019-05-09 stsp .El
2400 257add31 2020-09-09 stsp .Sh FILES
2401 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
2402 257add31 2020-09-09 stsp .It Pa got.conf
2403 257add31 2020-09-09 stsp Repository-wide configuration settings for
2404 257add31 2020-09-09 stsp .Nm .
2405 50b0790e 2020-09-11 stsp If present, a
2406 50b0790e 2020-09-11 stsp .Xr got.conf 5
2407 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
2408 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
2409 257add31 2020-09-09 stsp .Pa config
2410 257add31 2020-09-09 stsp file.
2411 50b0790e 2020-09-11 stsp .Pp
2412 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
2413 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
2414 50b0790e 2020-09-11 stsp .Nm .
2415 50b0790e 2020-09-11 stsp If present, a
2416 1795b260 2021-04-02 kn .Xr got.conf 5
2417 50b0790e 2020-09-11 stsp configuration file in the
2418 50b0790e 2020-09-11 stsp .Pa .got
2419 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
2420 50b0790e 2020-09-11 stsp the repository's
2421 50b0790e 2020-09-11 stsp .Xr got.conf 5
2422 50b0790e 2020-09-11 stsp configuration file and Git's
2423 50b0790e 2020-09-11 stsp .Pa config
2424 50b0790e 2020-09-11 stsp file.
2425 257add31 2020-09-09 stsp .El
2426 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
2427 5c860e29 2018-03-12 stsp .Ex -std got
2428 97925469 2018-03-17 stsp .Sh EXAMPLES
2429 43e4eb1b 2021-08-29 stsp Enable tab-completion of
2430 43e4eb1b 2021-08-29 stsp .Nm
2431 43e4eb1b 2021-08-29 stsp command names in
2432 43e4eb1b 2021-08-29 stsp .Xr ksh 1 :
2433 43e4eb1b 2021-08-29 stsp .Pp
2434 e1d27370 2021-09-01 stsp .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2435 43e4eb1b 2021-08-29 stsp .Pp
2436 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
2437 fa6e0e48 2019-05-23 stsp .Nm .
2438 fd039d72 2020-03-18 stsp .Pp
2439 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
2440 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
2441 fd039d72 2020-03-18 stsp .Pp
2442 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
2443 fa6e0e48 2019-05-23 stsp .Xr git 1 :
2444 d83d9d5c 2019-05-13 stsp .Pp
2445 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
2446 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
2447 fa6e0e48 2019-05-23 stsp .Pp
2448 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
2449 3ce1b845 2019-07-15 stsp .Nm
2450 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
2451 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
2452 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
2453 fa6e0e48 2019-05-23 stsp .Pp
2454 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
2455 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2456 3ce1b845 2019-07-15 stsp .Pp
2457 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
2458 3ce1b845 2019-07-15 stsp .Pp
2459 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
2460 fa6e0e48 2019-05-23 stsp .Pp
2461 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
2462 e70c17ce 2019-05-22 stsp .Pp
2463 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
2464 33aa809d 2019-08-08 stsp .Pp
2465 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
2466 081470ac 2020-08-13 stsp .Pp
2467 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
2468 081470ac 2020-08-13 stsp .Pp
2469 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
2470 e70c17ce 2019-05-22 stsp .Pp
2471 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
2472 33aa809d 2019-08-08 stsp .Pp
2473 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
2474 e70c17ce 2019-05-22 stsp .Pp
2475 4e759de4 2019-06-26 stsp .Dl $ got branch -l
2476 e70c17ce 2019-05-22 stsp .Pp
2477 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
2478 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
2479 d83d9d5c 2019-05-13 stsp which is forked off the
2480 d83d9d5c 2019-05-13 stsp .Dq master
2481 d83d9d5c 2019-05-13 stsp branch:
2482 d83d9d5c 2019-05-13 stsp .Pp
2483 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
2484 e70c17ce 2019-05-22 stsp .Pp
2485 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
2486 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
2487 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
2488 e70c17ce 2019-05-22 stsp .Pp
2489 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
2490 e70c17ce 2019-05-22 stsp .Pp
2491 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
2492 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
2493 fa6e0e48 2019-05-23 stsp .Pp
2494 fa6e0e48 2019-05-23 stsp .Dl $ got commit
2495 fa6e0e48 2019-05-23 stsp .Pp
2496 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
2497 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
2498 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
2499 fa6e0e48 2019-05-23 stsp .Pp
2500 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
2501 04e9dcf3 2020-04-18 stsp .Pp
2502 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
2503 04e9dcf3 2020-04-18 stsp .Xr patch 1
2504 04e9dcf3 2020-04-18 stsp could apply them in sequence:
2505 5b666081 2020-02-24 stsp .Pp
2506 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
2507 04e9dcf3 2020-04-18 stsp .Pp
2508 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
2509 5b666081 2020-02-24 stsp .Pp
2510 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
2511 5b666081 2020-02-24 stsp .Pp
2512 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
2513 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
2514 5b666081 2020-02-24 stsp .Pa sys/uvm :
2515 fa6e0e48 2019-05-23 stsp .Pp
2516 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
2517 5b666081 2020-02-24 stsp .Pp
2518 5b666081 2020-02-24 stsp And this command has the same effect:
2519 5b666081 2020-02-24 stsp .Pp
2520 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
2521 5b666081 2020-02-24 stsp .Pp
2522 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
2523 b2118c49 2020-07-28 stsp .Pp
2524 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
2525 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
2526 b2118c49 2020-07-28 stsp .Pp
2527 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
2528 e70c17ce 2019-05-22 stsp .Pp
2529 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
2530 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
2531 e70c17ce 2019-05-22 stsp .Pp
2532 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
2533 e70c17ce 2019-05-22 stsp with a pre-defined log message.
2534 e70c17ce 2019-05-22 stsp .Pp
2535 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
2536 95fc3404 2019-07-15 stsp .Pp
2537 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
2538 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
2539 1795b260 2021-04-02 kn .Pa /tmp/msg :
2540 bcbc2272 2020-05-20 stsp .Pp
2541 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
2542 bcbc2272 2020-05-20 stsp .Pp
2543 95fc3404 2019-07-15 stsp Update any work tree checked out from the
2544 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
2545 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
2546 95fc3404 2019-07-15 stsp .Pp
2547 95fc3404 2019-07-15 stsp .Dl $ got update
2548 ac90e726 2019-07-15 stsp .Pp
2549 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
2550 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
2551 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
2552 e70c17ce 2019-05-22 stsp .Pp
2553 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
2554 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
2555 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
2556 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
2557 ac90e726 2019-07-15 stsp .Pp
2558 a099809f 2021-08-27 stsp Fetch new changes on the remote repository's
2559 a099809f 2021-08-27 stsp .Dq master
2560 a099809f 2021-08-27 stsp branch, making them visible on the local repository's
2561 469dd726 2020-03-20 stsp .Dq origin/master
2562 469dd726 2020-03-20 stsp branch:
2563 fa6e0e48 2019-05-23 stsp .Pp
2564 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
2565 469dd726 2020-03-20 stsp .Dl $ got fetch
2566 469dd726 2020-03-20 stsp .Pp
2567 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
2568 469dd726 2020-03-20 stsp .Cm git clone --bare
2569 469dd726 2020-03-20 stsp the
2570 469dd726 2020-03-20 stsp .Xr git-fetch 1
2571 469dd726 2020-03-20 stsp command must be used instead:
2572 469dd726 2020-03-20 stsp .Pp
2573 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
2574 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
2575 fa6e0e48 2019-05-23 stsp .Pp
2576 469dd726 2020-03-20 stsp Rebase the local
2577 469dd726 2020-03-20 stsp .Dq master
2578 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
2579 469dd726 2020-03-20 stsp .Dq origin/master
2580 469dd726 2020-03-20 stsp branch:
2581 469dd726 2020-03-20 stsp .Pp
2582 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
2583 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
2584 469dd726 2020-03-20 stsp .Dl $ got rebase master
2585 469dd726 2020-03-20 stsp .Pp
2586 fa6e0e48 2019-05-23 stsp Rebase the
2587 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
2588 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
2589 fa6e0e48 2019-05-23 stsp .Dq master
2590 fa6e0e48 2019-05-23 stsp branch.
2591 fa6e0e48 2019-05-23 stsp .Pp
2592 818c7501 2019-07-11 stsp .Dl $ got update -b master
2593 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
2594 7d7ffedb 2019-07-14 stsp .Pp
2595 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
2596 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
2597 1dd86744 2019-08-12 anthony .Ox Ns 's
2598 1dd86744 2019-08-12 anthony CVS tree:
2599 7d7ffedb 2019-07-14 stsp .Pp
2600 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2601 7d7ffedb 2019-07-14 stsp .Pp
2602 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
2603 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
2604 0ebf8283 2019-07-24 stsp branch:
2605 0ebf8283 2019-07-24 stsp .Pp
2606 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
2607 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
2608 0ebf8283 2019-07-24 stsp .Dl $ got histedit
2609 469dd726 2020-03-20 stsp .Pp
2610 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
2611 469dd726 2020-03-20 stsp .Cm git clone --bare
2612 7848a0e1 2020-03-19 stsp instead of
2613 7848a0e1 2020-03-19 stsp .Cm got clone ,
2614 ff2cf171 2019-07-28 stsp a Git
2615 ff2cf171 2019-07-28 stsp .Dq refspec
2616 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
2617 ff2cf171 2019-07-28 stsp into the
2618 ff2cf171 2019-07-28 stsp .Dq refs/remotes
2619 ff2cf171 2019-07-28 stsp namespace of the local repository.
2620 1795b260 2021-04-02 kn This can be achieved by setting Git's
2621 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
2622 ff2cf171 2019-07-28 stsp configuration variable to the value
2623 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
2624 ff2cf171 2019-07-28 stsp with the
2625 ff2cf171 2019-07-28 stsp .Cm git config
2626 ff2cf171 2019-07-28 stsp command:
2627 ff2cf171 2019-07-28 stsp .Pp
2628 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
2629 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2630 eac81709 2020-03-21 stsp .Pp
2631 469dd726 2020-03-20 stsp Additionally, the
2632 469dd726 2020-03-20 stsp .Dq mirror
2633 469dd726 2020-03-20 stsp option must be disabled:
2634 ff2cf171 2019-07-28 stsp .Pp
2635 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
2636 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
2637 469dd726 2020-03-20 stsp .Pp
2638 ff2cf171 2019-07-28 stsp Alternatively, the following
2639 469dd726 2020-03-20 stsp .Xr git-fetch 1
2640 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
2641 ff2cf171 2019-07-28 stsp .Pa config
2642 ff2cf171 2019-07-28 stsp file:
2643 0ebf8283 2019-07-24 stsp .Pp
2644 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
2645 ff2cf171 2019-07-28 stsp .Dl url = ...
2646 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2647 469dd726 2020-03-20 stsp .Dl mirror = false
2648 ff2cf171 2019-07-28 stsp .Pp
2649 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
2650 ff2cf171 2019-07-28 stsp .Dq refs/heads
2651 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
2652 ff2cf171 2019-07-28 stsp .Cm got checkout
2653 ff2cf171 2019-07-28 stsp and, if needed, created with
2654 ff2cf171 2019-07-28 stsp .Cm got branch .
2655 ff2cf171 2019-07-28 stsp Branches in the
2656 a099809f 2021-08-27 stsp .Dq refs/remotes/origin
2657 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
2658 ff2cf171 2019-07-28 stsp repository with
2659 469dd726 2020-03-20 stsp .Cm got fetch
2660 469dd726 2020-03-20 stsp or
2661 469dd726 2020-03-20 stsp .Xr git-fetch 1
2662 a099809f 2021-08-27 stsp without extra command line arguments.
2663 a099809f 2021-08-27 stsp Newly fetched changes can be examined with
2664 a099809f 2021-08-27 stsp .Cm got log .
2665 ff2cf171 2019-07-28 stsp .Pp
2666 a099809f 2021-08-27 stsp Display changes on the remote repository's version of the
2667 ff2cf171 2019-07-28 stsp .Dq master
2668 a099809f 2021-08-27 stsp branch, as of the last time
2669 a099809f 2021-08-27 stsp .Cm got fetch
2670 a099809f 2021-08-27 stsp was run:
2671 a099809f 2021-08-27 stsp .Pp
2672 a099809f 2021-08-27 stsp .Dl $ got log -c origin/master | less
2673 a099809f 2021-08-27 stsp .Pp
2674 a099809f 2021-08-27 stsp As shown here, most commands accept abbreviated reference names such as
2675 ff2cf171 2019-07-28 stsp .Dq origin/master
2676 a099809f 2021-08-27 stsp instead of
2677 a099809f 2021-08-27 stsp .Dq refs/remotes/origin/master .
2678 a099809f 2021-08-27 stsp The latter is only needed in case of ambiguity.
2679 a099809f 2021-08-27 stsp .Pp
2680 a099809f 2021-08-27 stsp .Cm got rebase
2681 a099809f 2021-08-27 stsp must be used to merge changes which are visible on the
2682 a099809f 2021-08-27 stsp .Dq origin/master
2683 a099809f 2021-08-27 stsp branch into the
2684 a099809f 2021-08-27 stsp .Dq master
2685 7b0db533 2020-02-04 stsp branch.
2686 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
2687 ff2cf171 2019-07-28 stsp .Pp
2688 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
2689 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
2690 083957f4 2020-02-24 stsp .Pp
2691 a099809f 2021-08-27 stsp In order to make changes committed to the
2692 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
2693 a099809f 2021-08-27 stsp visible on the
2694 a099809f 2021-08-27 stsp .Dq master
2695 a099809f 2021-08-27 stsp branch, the
2696 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
2697 a099809f 2021-08-27 stsp branch must first be rebased onto the
2698 a099809f 2021-08-27 stsp .Dq master
2699 a099809f 2021-08-27 stsp branch:
2700 a099809f 2021-08-27 stsp .Pp
2701 a099809f 2021-08-27 stsp .Dl $ got update -b master
2702 a099809f 2021-08-27 stsp .Dl $ got rebase unified-buffer-cache
2703 a099809f 2021-08-27 stsp .Pp
2704 a099809f 2021-08-27 stsp Changes on the
2705 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
2706 a099809f 2021-08-27 stsp branch can now be made visible on the
2707 a099809f 2021-08-27 stsp .Dq master
2708 a099809f 2021-08-27 stsp branch with
2709 a099809f 2021-08-27 stsp .Cm got integrate .
2710 a099809f 2021-08-27 stsp Because the rebase operation switched the work tree to the
2711 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
2712 a099809f 2021-08-27 stsp branch the work tree must be switched back to the
2713 a099809f 2021-08-27 stsp .Dq master
2714 a099809f 2021-08-27 stsp branch first:
2715 a099809f 2021-08-27 stsp .Pp
2716 a099809f 2021-08-27 stsp .Dl $ got update -b master
2717 a099809f 2021-08-27 stsp .Dl $ got integrate unified-buffer-cache
2718 a099809f 2021-08-27 stsp .Pp
2719 083957f4 2020-02-24 stsp On the
2720 083957f4 2020-02-24 stsp .Dq master
2721 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
2722 083957f4 2020-02-24 stsp .Dq OK
2723 083957f4 2020-02-24 stsp by other developers and any other important new information:
2724 ff2cf171 2019-07-28 stsp .Pp
2725 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
2726 083957f4 2020-02-24 stsp .Dl $ got histedit -m
2727 083957f4 2020-02-24 stsp .Pp
2728 a099809f 2021-08-27 stsp If the remote repository offers write access local changes on the
2729 ff2cf171 2019-07-28 stsp .Dq master
2730 a099809f 2021-08-27 stsp branch can be sent to the remote repository with
2731 a099809f 2021-08-27 stsp .Cm got send.
2732 a099809f 2021-08-27 stsp Usually,
2733 a099809f 2021-08-27 stsp .Cm got send
2734 a099809f 2021-08-27 stsp can be run without further arguments.
2735 a099809f 2021-08-27 stsp The arguments shown here match defaults, provided the work tree's
2736 a099809f 2021-08-27 stsp current branch is the
2737 a099809f 2021-08-27 stsp .Dq master
2738 a099809f 2021-08-27 stsp branch:
2739 ff2cf171 2019-07-28 stsp .Pp
2740 a099809f 2021-08-27 stsp .Dl $ got send -b master origin
2741 a099809f 2021-08-27 stsp .Pp
2742 a099809f 2021-08-27 stsp If the remote repository requires the HTTPS protocol the
2743 a099809f 2021-08-27 stsp .Xr git-push 1
2744 a099809f 2021-08-27 stsp command must be used instead:
2745 a099809f 2021-08-27 stsp .Pp
2746 a099809f 2021-08-27 stsp .Dl $ cd /var/git/src.git
2747 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
2748 5c860e29 2018-03-12 stsp .Sh SEE ALSO
2749 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
2750 2312fc47 2019-07-15 stsp .Xr tog 1 ,
2751 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
2752 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
2753 257add31 2020-09-09 stsp .Xr got.conf 5
2754 1a208aaf 2018-04-01 stsp .Sh AUTHORS
2755 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
2756 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
2757 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
2758 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
2759 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
2760 fa6e0e48 2019-05-23 stsp .Nm
2761 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
2762 1795b260 2021-04-02 kn .Pp
2763 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
2764 fa6e0e48 2019-05-23 stsp .Xr git 1
2765 cc63216e 2020-12-26 stsp to perform some tasks.
2766 cc63216e 2020-12-26 stsp In particular:
2767 cc63216e 2020-12-26 stsp .Bl -bullet
2768 cc63216e 2020-12-26 stsp .It
2769 cc63216e 2020-12-26 stsp Reading from remote repositories over HTTP or HTTPS protocols requires
2770 cc63216e 2020-12-26 stsp .Xr git-clone 1
2771 cc63216e 2020-12-26 stsp and
2772 cc63216e 2020-12-26 stsp .Xr git-fetch 1 .
2773 cc63216e 2020-12-26 stsp .It
2774 a099809f 2021-08-27 stsp Writing to remote repositories over HTTP or HTTPS protocols requires
2775 cc63216e 2020-12-26 stsp .Xr git-push 1 .
2776 cc63216e 2020-12-26 stsp .It
2777 cc63216e 2020-12-26 stsp The creation of merge commits, i.e. commits with two or more parent commits,
2778 cc63216e 2020-12-26 stsp requires
2779 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
2780 cc63216e 2020-12-26 stsp .It
2781 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
2782 cc63216e 2020-12-26 stsp .Cm got
2783 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
2784 cc63216e 2020-12-26 stsp .Xr git 1
2785 cc63216e 2020-12-26 stsp will usually produce better results.
2786 cc63216e 2020-12-26 stsp .El