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