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