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