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