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